The AreaCon Library  1.0
A C++ library for area-constrained partitioning operations
 All Classes Namespaces Files Functions Variables Pages
AreaCon::Parameters Class Reference

#include <areacon.h>

Public Member Functions

 Parameters (const double line_int_step=0.1, const double weights_step=0.1, const double centers_step=1, const double volume_tolerance=0.002, const double convergence_criterion=0.02, const int max_iterations_volume=200, const int max_iterations_centers=500, const double Volume_Lower_Bound=10e-6, const double Robustness_Constant=10e-8)
 

Public Attributes

const double line_int_step
 
const double weights_step
 
const double centers_step
 
const double volume_tolerance
 
const double convergence_criterion
 
const int max_iterations_volume
 
const int max_iterations_centers
 
const double Volume_Lower_Bound
 
const double Robustness_Constant
 

Private Member Functions

void CheckParameters (void)
 

Constructor & Destructor Documentation

AreaCon::Parameters::Parameters ( const double  line_int_step = 0.1,
const double  weights_step = 0.1,
const double  centers_step = 1,
const double  volume_tolerance = 0.002,
const double  convergence_criterion = 0.02,
const int  max_iterations_volume = 200,
const int  max_iterations_centers = 500,
const double  Volume_Lower_Bound = 10e-6,
const double  Robustness_Constant = 10e-8 
)

Default Constructor. Default values are recommended to produce reasonable solutions with reasonable efficiency in most scenarios.

Parameters
[in]line_int_stepSpacing parameter used for calculating line integrals
[in]weights_stepStep-size used in updating the weighting parameters
[in]centers_stepStep-size used in updating the center locations
[in]volume_toleranceParameter used in determining whether desired volumes have been acheived
[in]convergence_criterionParameter used as an algorithmic stopping criterion
[in]max_iterations_volumeUpper bound on the number of volumetric iterations
[in]max_iterations_centersUpper bound on the number of centroidal movement iterations
[in]Volume_Lower_BoundA lower bound on the weighted area of each region
[in]Robustness_ConstantA constant used to enhace numerical robustness (see Point class)

Member Function Documentation

void AreaCon::Parameters::CheckParameters ( void  )
private

Checks to see if user-input parameters satisfy the required bounds

Member Data Documentation

const double AreaCon::Parameters::centers_step

Step-size used in updating the center locations

const double AreaCon::Parameters::convergence_criterion

Parameter used as an algorithmic stopping criterion

const double AreaCon::Parameters::line_int_step

Spacing parameter used for calculating line integrals

const int AreaCon::Parameters::max_iterations_centers

Upper bound on the number of centroidal movement iterations

const int AreaCon::Parameters::max_iterations_volume

Upper bound on the number of volumetric iterations

const double AreaCon::Parameters::Robustness_Constant
const double AreaCon::Parameters::Volume_Lower_Bound
const double AreaCon::Parameters::volume_tolerance

Parameter used in determining whether desired volumes have been acheived

const double AreaCon::Parameters::weights_step

Step-size used in updating the weighting parameters


The documentation for this class was generated from the following files: