KSLCore/ksl.simopt.problem/FunctionalConstraint

FunctionalConstraint

class FunctionalConstraint(validNames: List<String>, val lhsFunc: ConstraintFunctionIfc, val rhsValue: Double = 0.0, val inequalityType: InequalityType = InequalityType.LESS_THAN) : ConstraintIfc

Represents a functional constraint in an optimization problem.

This class models a constraint where the left-hand side is computed using a user-defined function and is compared to a predefined right-hand side value using an inequality (less than or greater than).

The valid variable names are defined at the time of initialization, and the left-hand side function is applied to input values to compute the constraint's value.

Parameters

validNames

the input variable names that are valid for the function. The list must not be empty and must contain non-blank strings.

Constructors

FunctionalConstraint

constructor(validNames: List<String>, lhsFunc: ConstraintFunctionIfc, rhsValue: Double = 0.0, inequalityType: InequalityType = InequalityType.LESS_THAN)

Properties

inequalityFactor

open val inequalityFactor: Double

Used to turn greater than inequalities to less than inequalities

inequalityType

open override val inequalityType: InequalityType

The type of inequality (LESS_THAN or GREATER_THAN). Defaults to LESS_THAN.

lhsFunc

val lhsFunc: ConstraintFunctionIfc

The function used to compute the left-hand side of the equation.

ltRHSValue

open val ltRHSValue: Double

The right-hand side of the constraint adjusted for the direction of the inequality to ensure a less-than constraint

rhsValue

open override val rhsValue: Double = 0.0

The right-hand side value of the constraint. Defaults to 0.0.

validNames

val validNames: List<String>

Functions

computeLHS

open override fun computeLHS(values: Map<String, Double>): Double

Computes the value of the left-hand side of the constraint based on the supplied values for each input variable in the equation.

isSatisfied

open override fun isSatisfied(values: Map<String, Double>): Boolean

Computes the value of the left-hand side of the constraint based on the supplied values for each input variable in the equation and checks if the constraint is satisfied.

slack

open fun slack(inputs: Map<String, Double>): Double

The slack associated with the constraint based on the provided inputs. This is the difference between the right-hand side value and the left-hand side value.

toString

open override fun toString(): String

violation

open fun violation(inputs: Map<String, Double>): Double