Options
All
  • Public
  • Public/Protected
  • All
Menu

Library @swim/constraint

@swim/constraint

package documentation chat

@swim/constraint implements an incremental solver for systems of linear constraint equations. @swim/constraint is written in TypeScript, but can be used from either TypeScript or JavaScript. @swim/constraint is part of the @swim/core framework.

Installation

npm

For an npm-managed project, npm install @swim/constraint to make it a dependency. TypeScript sources will be installed into node_modules/@swim/constraint/main. Transpiled JavaScript and TypeScript definition files install into node_modules/@swim/constraint/lib/main. And a pre-built UMD script can be found in node_modules/@swim/constraint/dist/main/swim-constraint.js.

Browser

Browser applications can load swim-core.js, which comes bundled with the @swim/constraint library, directly from the SwimOS CDN.

<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-core.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-core.min.js"></script>

Alternatively, the standalone swim-system.js script may be loaded from the SwimOS CDN, which bundles @swim/constraint together with all other @swim/system libraries.

<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-system.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-system.min.js"></script>

Usage

ES6/TypeScript

@swim/constraint can be imported as an ES6 module from TypeScript and other ES6-compatible environments.

import * as constraint from "@swim/constraint";

CommonJS/Node.js

@swim/constraint can also be used as a CommonJS module in Node.js applications.

var constraint = require("@swim/constraint");

Browser

When loaded by a web browser, the swim-core.js script adds all @swim/constraint library exports to the global swim namespace.

The swim-system.js script also adds all @swim/constraint library exports to the global swim namespace, making it a drop-in replacement for swim-core.js when additional @swim/system libraries are needed.

Index

Type aliases

AnyConstraintExpression

AnyConstraintExpression: ConstraintExpression | number

AnyConstraintStrength

ConstraintRelation

ConstraintRelation: "le" | "eq" | "ge"

ConstraintStrength

ConstraintStrength: number

ConstraintStrengthInit

ConstraintStrengthInit: "required" | "strong" | "medium" | "weak"

Variables

ConstraintExpression

ConstraintExpression: { zero: ConstraintConstant; constant: any; fromAny: any; product: any; sum: any }

Type declaration

ConstraintKey

ConstraintKey: { idCount: number; nextId: any }

Type declaration

  • idCount: number
  • nextId: function
    • nextId(): number
    • Returns number

ConstraintStrength

ConstraintStrength: { Medium: number; Required: number; Strong: number; Unbound: number; Weak: number; clip: any; fromAny: any }

Type declaration

  • Readonly Medium: number
  • Readonly Required: number
  • Readonly Strong: number
  • Readonly Unbound: number
  • Readonly Weak: number
  • clip: function
    • clip(strength: number): number
    • Parameters

      • strength: number

      Returns number

  • fromAny: function
    • Parameters

      Returns number

ConstraintSymbol

ConstraintSymbol: { invalid: ConstraintInvalid }

Type declaration

ConstraintTerm

ConstraintTerm: { is: any }

Type declaration

  • is: function
    • Parameters

      • value: unknown

      Returns value is ConstraintTerm

Generated using TypeDoc