Skip to content

Latest commit

 

History

History
559 lines (375 loc) · 23.3 KB

Kiwi.md

File metadata and controls

559 lines (375 loc) · 23.3 KB
Raw

@lume/kiwi

Lume Kiwi is an efficient implementation of the Cassowary constraint solving algorithm, based on the seminal Cassowary paper. It is not a refactoring or port of the original C++ solver, but has been designed from the ground up to be lightweight and fast.

Example

import * as kiwi from '@lume/kiwi'

// Create a solver
const solver = new kiwi.Solver()

// Adjust the max number of solver iterations before an error is thrown if
// more is needed. Default is 10,000.
solver.maxIterations = 20000

// Create and add some editable variables
const left = new kiwi.Variable()
const width = new kiwi.Variable()
solver.addEditVariable(left, kiwi.Strength.strong)
solver.addEditVariable(width, kiwi.Strength.strong)

// Create a variable calculated through a constraint
const centerX = new kiwi.Variable()
const expr = new kiwi.Expression([-1, centerX], left, [0.5, width])
solver.addConstraint(new kiwi.Constraint(expr, kiwi.Operator.Eq, kiwi.Strength.required))

// Suggest some values to the solver
solver.suggestValue(left, 0)
solver.suggestValue(width, 500)

// Lets solve the problem!
solver.updateVariables()

console.assert(centerX.value() === 250)

API Documentation

@lume/kiwi~Variable

The primary user constraint variable.

Kind: inner class of @lume/kiwi

new Variable([name])

Param Type Default Description
[name] String "" The name to associated with the variable.

variable.name() ⇒ String

Returns the name of the variable.

Kind: instance method of Variable
Returns: String - name of the variable

variable.setName(name)

Set the name of the variable.

Kind: instance method of Variable

Param Type Description
name String Name of the variable

variable.value() ⇒ Number

Returns the value of the variable.

Kind: instance method of Variable
Returns: Number - Calculated value

variable.plus(value) ⇒ Expression

Creates a new Expression by adding a number, variable or expression to the variable.

Kind: instance method of Variable
Returns: Expression - expression

Param Type Description
value Number | Variable | Expression Value to add.

variable.minus(value) ⇒ Expression

Creates a new Expression by substracting a number, variable or expression from the variable.

Kind: instance method of Variable
Returns: Expression - expression

Param Type Description
value Number | Variable | Expression Value to substract.

variable.multiply(coefficient) ⇒ Expression

Creates a new Expression by multiplying with a fixed number.

Kind: instance method of Variable
Returns: Expression - expression

Param Type Description
coefficient Number Coefficient to multiply with.

variable.divide(coefficient) ⇒ Expression

Creates a new Expression by dividing with a fixed number.

Kind: instance method of Variable
Returns: Expression - expression

Param Type Description
coefficient Number Coefficient to divide by.

@lume/kiwi~Expression

An expression of variable terms and a constant.

The constructor accepts an arbitrary number of parameters, each of which must be one of the following types:

  • number
  • Variable
  • Expression
  • 2-tuple of [number, Variable|Expression]

The parameters are summed. The tuples are multiplied.

Kind: inner class of @lume/kiwi

new Expression(...args)

Param Type
...args number | Variable | Expression | Array

expression.plus(value) ⇒ Expression

Creates a new Expression by adding a number, variable or expression to the expression.

Kind: instance method of Expression
Returns: Expression - expression

Param Type Description
value Number | Variable | Expression Value to add.

expression.minus(value) ⇒ Expression

Creates a new Expression by substracting a number, variable or expression from the expression.

Kind: instance method of Expression
Returns: Expression - expression

Param Type Description
value Number | Variable | Expression Value to substract.

expression.multiply(coefficient) ⇒ Expression

Creates a new Expression by multiplying with a fixed number.

Kind: instance method of Expression
Returns: Expression - expression

Param Type Description
coefficient Number Coefficient to multiply with.

expression.divide(coefficient) ⇒ Expression

Creates a new Expression by dividing with a fixed number.

Kind: instance method of Expression
Returns: Expression - expression

Param Type Description
coefficient Number Coefficient to divide by.

@lume/kiwi~Strength

Kind: inner class of @lume/kiwi

strength.required

The 'required' symbolic strength.

Kind: instance property of Strength

strength.strong

The 'strong' symbolic strength.

Kind: instance property of Strength

strength.medium

The 'medium' symbolic strength.

Kind: instance property of Strength

strength.weak

The 'weak' symbolic strength.

Kind: instance property of Strength

Strength.create(a, b, c, [w]) ⇒

Create a new symbolic strength.

Kind: static method of Strength
Returns: strength

Param Default Description
a strong
b medium
c weak
[w] 1 weight

@lume/kiwi~Constraint

A linear constraint equation.

A constraint equation is composed of an expression, an operator, and a strength. The RHS of the equation is implicitly zero.

Kind: inner class of @lume/kiwi

new Constraint(expression, operator, [rhs], [strength])

Param Type Default Description
expression Expression The constraint expression (LHS).
operator Operator The equation operator.
[rhs] Expression Right hand side of the expression.
[strength] Number Strength.required The strength of the constraint.

constraint.expression() ⇒ Expression

Returns the expression of the constraint.

Kind: instance method of Constraint
Returns: Expression - expression

constraint.op() ⇒ Operator

Returns the relational operator of the constraint.

Kind: instance method of Constraint
Returns: Operator - linear constraint operator

constraint.strength() ⇒ Number

Returns the strength of the constraint.

Kind: instance method of Constraint
Returns: Number - strength

@lume/kiwi~Solver

The constraint solver class.

Kind: inner class of @lume/kiwi

new Solver()

Construct a new Solver.

solver.maxIterations : number

  • The max number of solver iterations before an erroris thrown, in order to prevent infinite iteration. Default: 10,000.

Kind: instance property of Solver

solver.createConstraint(lhs, operator, rhs, [strength])

Creates and add a constraint to the solver.

Kind: instance method of Solver

Param Type Default Description
lhs Expression | Variable Left hand side of the expression
operator Operator Operator
rhs Expression | Variable | Number Right hand side of the expression
[strength] Number Strength.required Strength

solver.addConstraint(constraint)

Add a constraint to the solver.

Kind: instance method of Solver

Param Type Description
constraint Constraint Constraint to add to the solver

solver.removeConstraint(constraint)

Remove a constraint from the solver.

Kind: instance method of Solver

Param Type Description
constraint Constraint Constraint to remove from the solver

solver.hasConstraint(constraint) ⇒ Bool

Test whether the solver contains the constraint.

Kind: instance method of Solver
Returns: Bool - true or false

Param Type Description
constraint Constraint Constraint to test for

solver.getConstraints() ⇒ [ 'Array' ].<Constraint>

Get an array of the current constraints.

Kind: instance method of Solver

solver.addEditVariable(variable, strength)

Add an edit variable to the solver.

Kind: instance method of Solver

Param Type Description
variable Variable Edit variable to add to the solver
strength Number Strength, should be less than Strength.required

solver.removeEditVariable(variable)

Remove an edit variable from the solver.

Kind: instance method of Solver

Param Type Description
variable Variable Edit variable to remove from the solver

solver.hasEditVariable(variable) ⇒ Bool

Test whether the solver contains the edit variable.

Kind: instance method of Solver
Returns: Bool - true or false

Param Type Description
variable Variable Edit variable to test for

solver.suggestValue(variable, value)

Suggest the value of an edit variable.

Kind: instance method of Solver

Param Type Description
variable Variable Edit variable to suggest a value for
value Number Suggested value

solver.updateVariables()

Update the values of the variables.

Kind: instance method of Solver

@lume/kiwi~Operator : enum

An enum defining the linear constraint operators.

Value Operator Description
Le <= Less than equal
Ge >= Greater than equal
Eq == Equal

Kind: inner enum of @lume/kiwi