FMT 1.2.0
Forest management tools for forest planning
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
Heuristics::FMTOperatingAreaCluster Class Reference

Potential cluster of multiple operating areas. More...

#include <FMTOperatingAreaCluster.h>

Public Member Functions

 FMTOperatingAreaCluster ()=default
 Default constructor for FMTOperatingAreaCluster.
 
 FMTOperatingAreaCluster (const FMTOperatingAreaClusterBinary &p_localcentroid, const std::vector< FMTOperatingAreaClusterBinary > &p_neighborsbinaries)
 Incomplete constructor for FMTOperatingAreaCluster from a centroid and its neighbors binaries.
 
 FMTOperatingAreaCluster (const FMTOperatingAreaCluster &p_basecluster, const double &p_minimalarea, const double &p_maximalarea)
 Complete constructor for FMTOperatingAreaCluster from a base cluster and its minimal and maximal area.
 
 FMTOperatingAreaCluster (const FMTOperatingAreaCluster &)=default
 Default copy constructor for FMTOperatingAreaCluster.
 
FMTOperatingAreaCluster & operator= (const FMTOperatingAreaCluster &)=default
 Default copy assignment operator for FMTOperatingAreaCluster.
 
 ~FMTOperatingAreaCluster ()=default
 Default destructor for FMTOperatingAreaCluster.
 
const FMTOperatingAreaClusterBinary & getBinary (const Core::FMTMask &mask) const
 Return the binary of the cluster corresponding to a given mask.
 
FMTOperatingAreaClusterBinary getCentroid () const
 Return the centroid binary of the cluster.
 
std::vector< FMTOperatingAreaClusterBinary > getBinaries () const
 Return the binaries of the cluster.
 
int getMaximalObjectiveVariable () const
 Return the maximal objective variable.
 
int getMinimalObjectiveVariable () const
 Return the minimal objective variable.
 
double getMinimalArea () const
 Get the minimal area of the potential cluster considering the number of binaries in the cluster.
 
double getMaximalArea () const
 Get the maximal area of the potential cluster considering the number of binaries in the cluster.
 
double getMaximalStats () const
 Get the maximal statistic for the whole cluster.
 
double getRealMinimalArea () const
 Return the minimal area member of the cluster.
 
double getRealMaximalArea () const
 Return the maximal area member of the cluster.
 
double getTotalPotentialArea () const
 Get the maximal potential area of the cluster.
 
bool isValidArea (const double &area) const
 Check if an area is valid for the cluster (between the bounds).
 
void setMaximalObjectiveVariable (const int &lmaxvar)
 Set the maximal objective variable of the cluster.
 
void setMinimalObjectiveVariable (const int &lminvar)
 Set the minimal objective variable of the cluster.
 
void setMinimalArea (const double &newminimalarea)
 Set the minimal area of the cluster.
 
void setMaximalArea (const double &newmaximalarea)
 Set the potential maximal area of the cluster.
 
bool isValidAreaBounds () const
 Validate that the minimal and maximal area set by the user respect the binaries present in the cluster.
 
FMTOperatingAreaCluster getFilteredCluster (const Core::FMTMask &filterMask) const
 Return a cluster with the binaries not falling in a mask definition removed, which can reduce the number of binaries.
 
std::vector< Core::FMTMask > getAllMasks () const
 Return all the masks contained by the cluster, including the operating area centroid.
 

Friends

class boost::serialization::access
 

Detailed Description

Potential cluster of multiple operating areas.

Each operating area is represented by a FMTOperatingAreaClusterBinary and the centroid of the cluster is also a FMTOperatingAreaClusterBinary; the cluster is active if the centroid binary is active.

Constructor & Destructor Documentation

◆ FMTOperatingAreaCluster() [1/4]

Heuristics::FMTOperatingAreaCluster::FMTOperatingAreaCluster ( )
default

Default constructor for FMTOperatingAreaCluster.

◆ FMTOperatingAreaCluster() [2/4]

Heuristics::FMTOperatingAreaCluster::FMTOperatingAreaCluster ( const FMTOperatingAreaClusterBinary &  p_localcentroid,
const std::vector< FMTOperatingAreaClusterBinary > &  p_neighborsbinaries 
)

Incomplete constructor for FMTOperatingAreaCluster from a centroid and its neighbors binaries.

Parameters
[in]p_localcentroidthe centroid binary.
[in]p_neighborsbinariesthe neighbors binaries.

◆ FMTOperatingAreaCluster() [3/4]

Heuristics::FMTOperatingAreaCluster::FMTOperatingAreaCluster ( const FMTOperatingAreaCluster &  p_basecluster,
const double &  p_minimalarea,
const double &  p_maximalarea 
)

Complete constructor for FMTOperatingAreaCluster from a base cluster and its minimal and maximal area.

Parameters
[in]p_baseclusterthe base cluster.
[in]p_minimalareathe minimal area.
[in]p_maximalareathe maximal area.

◆ FMTOperatingAreaCluster() [4/4]

Heuristics::FMTOperatingAreaCluster::FMTOperatingAreaCluster ( const FMTOperatingAreaCluster &  )
default

Default copy constructor for FMTOperatingAreaCluster.

◆ ~FMTOperatingAreaCluster()

Heuristics::FMTOperatingAreaCluster::~FMTOperatingAreaCluster ( )
default

Default destructor for FMTOperatingAreaCluster.

Member Function Documentation

◆ getAllMasks()

std::vector< Core::FMTMask > Heuristics::FMTOperatingAreaCluster::getAllMasks ( ) const

Return all the masks contained by the cluster, including the operating area centroid.

Returns
the masks.

◆ getBinaries()

std::vector< FMTOperatingAreaClusterBinary > Heuristics::FMTOperatingAreaCluster::getBinaries ( ) const
inline

Return the binaries of the cluster.

Returns
the binaries.

◆ getBinary()

const FMTOperatingAreaClusterBinary & Heuristics::FMTOperatingAreaCluster::getBinary ( const Core::FMTMask &  mask) const

Return the binary of the cluster corresponding to a given mask.

Parameters
[in]maskthe mask.
Returns
the corresponding binary.

◆ getCentroid()

FMTOperatingAreaClusterBinary Heuristics::FMTOperatingAreaCluster::getCentroid ( ) const
inline

Return the centroid binary of the cluster.

Returns
the centroid binary.

◆ getFilteredCluster()

FMTOperatingAreaCluster Heuristics::FMTOperatingAreaCluster::getFilteredCluster ( const Core::FMTMask &  filterMask) const

Return a cluster with the binaries not falling in a mask definition removed, which can reduce the number of binaries.

Parameters
[in]filterMaskthe filter mask.
Returns
the filtered cluster.

◆ getMaximalArea()

double Heuristics::FMTOperatingAreaCluster::getMaximalArea ( ) const

Get the maximal area of the potential cluster considering the number of binaries in the cluster.

Returns
the maximal area.

◆ getMaximalObjectiveVariable()

int Heuristics::FMTOperatingAreaCluster::getMaximalObjectiveVariable ( ) const
inline

Return the maximal objective variable.

Returns
the maximal objective variable.

◆ getMaximalStats()

double Heuristics::FMTOperatingAreaCluster::getMaximalStats ( ) const

Get the maximal statistic for the whole cluster.

Returns
the maximal statistic.

◆ getMinimalArea()

double Heuristics::FMTOperatingAreaCluster::getMinimalArea ( ) const

Get the minimal area of the potential cluster considering the number of binaries in the cluster.

Returns
the minimal area.

◆ getMinimalObjectiveVariable()

int Heuristics::FMTOperatingAreaCluster::getMinimalObjectiveVariable ( ) const
inline

Return the minimal objective variable.

Returns
the minimal objective variable.

◆ getRealMaximalArea()

double Heuristics::FMTOperatingAreaCluster::getRealMaximalArea ( ) const
inline

Return the maximal area member of the cluster.

Returns
the real maximal area.

◆ getRealMinimalArea()

double Heuristics::FMTOperatingAreaCluster::getRealMinimalArea ( ) const
inline

Return the minimal area member of the cluster.

Returns
the real minimal area.

◆ getTotalPotentialArea()

double Heuristics::FMTOperatingAreaCluster::getTotalPotentialArea ( ) const

Get the maximal potential area of the cluster.

Returns
the total potential area.

◆ isValidArea()

bool Heuristics::FMTOperatingAreaCluster::isValidArea ( const double &  area) const

Check if an area is valid for the cluster (between the bounds).

Parameters
[in]areathe area.
Returns
true if the area is valid else false.

◆ isValidAreaBounds()

bool Heuristics::FMTOperatingAreaCluster::isValidAreaBounds ( ) const

Validate that the minimal and maximal area set by the user respect the binaries present in the cluster.

Returns
true if the area bounds are valid else false.

◆ operator=()

FMTOperatingAreaCluster & Heuristics::FMTOperatingAreaCluster::operator= ( const FMTOperatingAreaCluster &  )
default

Default copy assignment operator for FMTOperatingAreaCluster.

Returns
a reference to this FMTOperatingAreaCluster.

◆ setMaximalArea()

void Heuristics::FMTOperatingAreaCluster::setMaximalArea ( const double &  newmaximalarea)

Set the potential maximal area of the cluster.

Parameters
[in]newmaximalareathe new maximal area.

◆ setMaximalObjectiveVariable()

void Heuristics::FMTOperatingAreaCluster::setMaximalObjectiveVariable ( const int &  lmaxvar)

Set the maximal objective variable of the cluster.

Parameters
[in]lmaxvarthe maximal objective variable.

◆ setMinimalArea()

void Heuristics::FMTOperatingAreaCluster::setMinimalArea ( const double &  newminimalarea)

Set the minimal area of the cluster.

Parameters
[in]newminimalareathe new minimal area.

◆ setMinimalObjectiveVariable()

void Heuristics::FMTOperatingAreaCluster::setMinimalObjectiveVariable ( const int &  lminvar)

Set the minimal objective variable of the cluster.

Parameters
[in]lminvarthe minimal objective variable.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.6