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

#include <FMToperatingareaclusterbinary.hpp>

Inheritance diagram for Heuristics::FMToperatingareaclusterbinary:
[legend]
Collaboration diagram for Heuristics::FMToperatingareaclusterbinary:
[legend]

Public Member Functions

 FMToperatingareaclusterbinary ()=default
 
 FMToperatingareaclusterbinary (const FMToperatingareaclusterbinary &)=default
 
FMToperatingareaclusterbinaryoperator= (const FMToperatingareaclusterbinary &)=default
 
 ~FMToperatingareaclusterbinary ()=default
 
 FMToperatingareaclusterbinary (const FMToperatingarea &oparea)
 
std::vector< FMToperatingareaclusterbinaryfilterneighbors (std::vector< FMToperatingareaclusterbinary > potentiallink) const
 
Core::FMToutput getoutputintersect (const Core::FMToutput &output, const std::vector< Core::FMTtheme > &themes) const
 
void setstatistic (const double &statvalue)
 
void setvariable (const int &lvariable)
 
const int & getvariable () const
 
const double & getstatistic () const
 
- Public Member Functions inherited from Heuristics::FMToperatingarea
FMToperatingareaoperator+= (const double &value)
 
std::vector< Core::FMTmaskgetneighbors () const
 
double getarea () const
 
double getneihgborsperimeter () const
 
Core::FMTmask getmask () const
 
void setneighbors (const std::vector< Core::FMTmask > &lneighbors)
 
 FMToperatingarea (const Core::FMTmask &lmask, const double &lneihgborsperimeter)
 
void setarea (const double &newarea)
 
 FMToperatingarea ()=default
 
 FMToperatingarea (const FMToperatingarea &rhs)=default
 
FMToperatingareaoperator= (const FMToperatingarea &rhs)=default
 
bool operator== (const FMToperatingarea &rhs) const
 
bool operator!= (const FMToperatingarea &rhs) const
 
virtual ~FMToperatingarea ()=default
 
FMToperatingarea presolveoperatingarea (const Core::FMTmaskfilter &filter, const std::vector< Core::FMTtheme > &presolvedthemes) const
 
FMToperatingarea postsolveoperatingarea (const Core::FMTmaskfilter &filter, const std::vector< Core::FMTtheme > &basethemes) const
 

Friends

class boost::serialization::access
 

Additional Inherited Members

- Protected Attributes inherited from Heuristics::FMToperatingarea
Core::FMTmask mask
 The mask describing the operating area.
 
std::vector< Core::FMTmaskneighbors
 Neighbors mask of the operating area.
 
double neihgborsperimeter
 neighborsperimeter is the ratio a operatingarea needs to share to a other operatingarea to be considered neighbor.
 
double _area
 The initial area of the operating area used as big M for the MIP.
 

Detailed Description

FMToperatingareaclusterbinary is the definition of a non clustered operating area this class is used by the FMToperatingareacluster. The class contains extra informations for an FMToperating area. Eeach clusterbinary has a binary variable id, a maximal and minimal row statistic and finaly the statistic varlue of the binary used to calculate the objective function.

Constructor & Destructor Documentation

◆ FMToperatingareaclusterbinary() [1/3]

Heuristics::FMToperatingareaclusterbinary::FMToperatingareaclusterbinary ( )
default

FMToperatingareaclusterbinary default constructor.

◆ FMToperatingareaclusterbinary() [2/3]

Heuristics::FMToperatingareaclusterbinary::FMToperatingareaclusterbinary ( const FMToperatingareaclusterbinary )
default

FMToperatingareaclusterbinary default copy constructor.

◆ ~FMToperatingareaclusterbinary()

Heuristics::FMToperatingareaclusterbinary::~FMToperatingareaclusterbinary ( )
default

FMToperatingareaclusterbinary default destructor.

◆ FMToperatingareaclusterbinary() [3/3]

Heuristics::FMToperatingareaclusterbinary::FMToperatingareaclusterbinary ( const FMToperatingarea oparea)

Member Function Documentation

◆ filterneighbors()

std::vector< FMToperatingareaclusterbinary > Heuristics::FMToperatingareaclusterbinary::filterneighbors ( std::vector< FMToperatingareaclusterbinary potentiallink) const

This function takes a vector of potential binary link and filter this list by looking at the neighbors of each binary to make sure that the linked list are real.y neighbors.

◆ getoutputintersect()

Core::FMToutput Heuristics::FMToperatingareaclusterbinary::getoutputintersect ( const Core::FMToutput output,
const std::vector< Core::FMTtheme > &  themes 
) const

Using an (output) this function is going to intersect the mask of the output with the mask of the operating area and it will result of an output targeting only the operating area.

◆ getstatistic()

const double & Heuristics::FMToperatingareaclusterbinary::getstatistic ( ) const
inline

Getter for the statistic value of the operating area.

◆ getvariable()

const int & Heuristics::FMToperatingareaclusterbinary::getvariable ( ) const
inline

Getter for the binary variable of the lpmodel that represent the operating area.

◆ operator=()

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

FMToperatingareaclusterbinary default copy assignment.

◆ setstatistic()

void Heuristics::FMToperatingareaclusterbinary::setstatistic ( const double &  statvalue)

Setter for the statistic of the clusterbinary that is going to be used in the global objective for minimizing heterogenity.

◆ setvariable()

void Heuristics::FMToperatingareaclusterbinary::setvariable ( const int &  lvariable)

Setter for the binary variable of the lpmodel that represent the operating area.

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: