Penalty-class: Penalty class

In prioritizr/prioritizr: Systematic Conservation Prioritization in R

Penalty class

Description

This class is used to represent penalties used in optimization. Only experts should use the fields and methods for this class directly.

Super class

prioritizr::ConservationModifier -> Penalty

Methods

Public methods

• Penalty$apply()

• Penalty$clone()

Inherited methods

• prioritizr::ConservationModifier$calculate()
• prioritizr::ConservationModifier$get_data()
• prioritizr::ConservationModifier$get_internal()
• prioritizr::ConservationModifier$print()
• prioritizr::ConservationModifier$repr()
• prioritizr::ConservationModifier$set_data()
• prioritizr::ConservationModifier$set_internal()
• prioritizr::ConservationModifier$show()

---

Method apply()

Update an optimization problem formulation.

Usage

Penalty$apply(x)

Arguments

x

optimization_problem() object.

Returns

Invisible TRUE.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Penalty$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other classes: ConservationModifier-class, ConservationProblem-class, Constraint-class, Decision-class, Objective-class, OptimizationProblem-class, Portfolio-class, Solver-class, Target-class

prioritizr/prioritizr documentation built on March 4, 2024, 3:54 p.m.