KSLCore/ksl.simopt.problem/LinearConstraint

LinearConstraint

data class LinearConstraint(val equation: Map<String, Double>, var rhsValue: Double = 0.0, val inequalityType: InequalityType = InequalityType.LESS_THAN) : ConstraintIfc(source)

Represents a linear-constraint for a ProblemDefinition.

Parameters

equation

the variable name and the coefficient in the equation. The names of the input variables must not be blank.

rhsValue

the right-hand side value of the constraint. The default is 0.0.

inequalityType

the type of inequality, less-than or greater-than. The default is InequalityType.LESS_THAN

Constructors

Link copied to clipboard
constructor(equation: Map<String, Double>, rhsValue: Double = 0.0, inequalityType: InequalityType = InequalityType.LESS_THAN)

Properties

Link copied to clipboard
val adjustedCoefficients: DoubleArray

The coefficients associated with each input variable name within the equation. These are adjusted for the direction of the inequality to ensure an A*x < b orientation.

Link copied to clipboard
val coefficients: DoubleArray

The coefficients associated with each input variable name within the equation. These are not adjusted for the direction of the inequality.

Link copied to clipboard
Link copied to clipboard
open override val inequalityType: InequalityType
Link copied to clipboard
val names: List<String>

The input variable names that are in the equation ordered based on appearance in the equation.

Link copied to clipboard
open override var rhsValue: Double

Functions

Link copied to clipboard
fun coefficient(name: String): Double
Link copied to clipboard
fun coefficients(inputNames: List<String>): DoubleArray

Returns the coefficients associated with the left-hand side of the constraint based on the supplied input names. The coefficients are not adjusted for the direction of the inequality.

Link copied to clipboard
fun computeLHS(values: DoubleArray): Double

Computes the value of the left-hand side of the constraint based on the supplied values for each input variable in the equation. Assumes that the values are ordered in the same order as the input names. The returned value has been adjusted to ensure a less-than constraint orientation.

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. The returned value has been adjusted to ensure a less-than constraint orientation.

Link copied to clipboard
fun isSatisfied(values: DoubleArray): 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.

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

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

Link copied to clipboard
open override fun toString(): String