class SolverVariable : Comparable


Represents a given variable used in the linear expression solver.

Summary

Nested types

Type of variables

Constants

const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int

Public constructors

Base constructor

Public functions

Unit
Int
String!

Accessor for the name

Unit
Unit
Unit
setFinalValue(system: LinearSystem!, value: Float)
Unit
setName(name: String!)
Unit
setSynonym(
    system: LinearSystem!,
    synonymVariable: SolverVariable!,
    value: Float
)
Unit
setType(type: SolverVariable.Type!, prefix: String!)
String!

Override the toString() method to display the variable

Unit
updateReferencesWithNewDefinition(
    system: LinearSystem!,
    definition: ArrayRow!
)

Constants

STRENGTH_BARRIER

Added in 1.1.0
const val STRENGTH_BARRIER = 6: Int

STRENGTH_CENTERING

Added in 1.1.0
const val STRENGTH_CENTERING = 7: Int

STRENGTH_EQUALITY

Added in 1.1.0
const val STRENGTH_EQUALITY = 5: Int

STRENGTH_FIXED

Added in 1.1.0
const val STRENGTH_FIXED = 8: Int

STRENGTH_HIGH

Added in 1.1.0
const val STRENGTH_HIGH = 3: Int

STRENGTH_HIGHEST

Added in 1.1.0
const val STRENGTH_HIGHEST = 4: Int

STRENGTH_LOW

Added in 1.1.0
const val STRENGTH_LOW = 1: Int

STRENGTH_MEDIUM

Added in 1.1.0
const val STRENGTH_MEDIUM = 2: Int

STRENGTH_NONE

Added in 1.1.0
const val STRENGTH_NONE = 0: Int

Public constructors

SolverVariable

Added in 1.1.0
SolverVariable(name: String!, type: SolverVariable.Type!)

Base constructor

Parameters
name: String!

the variable name

type: SolverVariable.Type!

the type of the variable

SolverVariable

Added in 1.1.0
SolverVariable(type: SolverVariable.Type!, prefix: String!)

Public functions

addToRow

Added in 1.1.0
fun addToRow(row: ArrayRow!): Unit

compareTo

Added in 1.1.0
fun compareTo(v: SolverVariable!): Int

getName

Added in 1.1.0
fun getName(): String!

Accessor for the name

Returns
String!

the name of the variable

removeFromRow

Added in 1.1.0
fun removeFromRow(row: ArrayRow!): Unit

reset

Added in 1.1.0
fun reset(): Unit

setFinalValue

Added in 1.1.0
fun setFinalValue(system: LinearSystem!, value: Float): Unit

setName

Added in 1.1.0
fun setName(name: String!): Unit

setSynonym

Added in 1.1.0
fun setSynonym(
    system: LinearSystem!,
    synonymVariable: SolverVariable!,
    value: Float
): Unit

setType

Added in 1.1.0
fun setType(type: SolverVariable.Type!, prefix: String!): Unit

toString

fun toString(): String!

Override the toString() method to display the variable

updateReferencesWithNewDefinition

Added in 1.1.0
fun updateReferencesWithNewDefinition(
    system: LinearSystem!,
    definition: ArrayRow!
): Unit

Public properties

computedValue

Added in 1.1.0
val computedValueFloat

id

Added in 1.1.0
val idInt

inGoal

Added in 1.1.0
val inGoalBoolean

isFinalValue

Added in 1.1.0
val isFinalValueBoolean

strength

Added in 1.1.0
val strengthInt

usageInRowCount

Added in 1.1.0
val usageInRowCountInt