Multi-objective conservation problem class
Source:R/MultiConservationProblem-class.R
MultiConservationProblem-class.RdThis class is used to represent multi-objective conservation planning
problems. It stores the data (e.g., planning units, and features) and
mathematical formulation (e.g., the objective, constraints,
and other design criteria) needed to generate prioritizations.
Most users should use multi_problem() to generate new
multi-objective conservation problem objects, and the functions distributed
with the package to interact
with them (e.g., number_of_features(), number_of_planning_units()).
Only experts should use the fields and methods for this class directly.
Public fields
problemslistcontainingConservationProblemobjects.defaultslistindicating if other fields contain defaults.approachMultiObjApproachobject for specifying the multi-objective optimization appraoch.solverSolverobject specifying the solver for generating solutions.
Methods
Public methods
MultiConservationProblem$new()
Create a new multi-objective conservation problem object.
Usage
MultiConservationProblem$new(problems)Arguments
problemslistcontainingConservationProblemobjects.
MultiConservationProblem$number_of_planning_units()
Obtain the number of planning units. The planning units correspond to
elements in the cost data
(e.g., indices, rows, geometries, cells) that have finite
values in at least one zone. In other words, planning unit are
elements in the cost data that do not have missing (NA) values in
every zone.
MultiConservationProblem$is_ids_equivalent_to_indices()
Check if planning unit identifiers are equivalent to the planning
unit indices? Only FALSE if the planning units are
data.frame format.
MultiConservationProblem$convert_total_unit_ids_to_indices()
Convert total unit identifiers to indices.
MultiConservationProblem$planning_unit_indices_with_finite_costs()
Obtain the planning unit indices that are associated with finite cost values.
MultiConservationProblem$number_of_total_units()
Obtain the number of total units. The total units include all elements
in the cost data
(e.g., indices, rows, geometries, cells), including those with
missing (NA) values.
MultiConservationProblem$add_approach()
Create a new object with an approach added to the problem formulation.
Arguments
xMultiObjApproach object.
MultiConservationProblem$add_solver()
Create a new object with a solver added to the problem formulation.
Arguments
xSolver object.