Class Num

Hierarchy

Cell<V>
- Num (View Summary)

Index

Accessors

Constructors

Methods

add affine clamp cyclic derive divisibleBy exp greaterThan lens lessThan merge peek quantize scale sin sub through to coerce derive is lens pin

Properties

_t name value traits

Accessors

isEven

get isEven(): this extends WritableBrand ? Writable<Bool> : Bool
True when even.

Returns this extends WritableBrand ? Writable<Bool> : Bool
- Defined in src/core/values/num.ts:215

isOdd

get isOdd(): this extends WritableBrand ? Writable<Bool> : Bool
True when odd.

Returns this extends WritableBrand ? Writable<Bool> : Bool
- Defined in src/core/values/num.ts:219

Constructors

constructor

new Num(v?: number): Num
Parameters
- v: number = 0
Returns Num
Overrides Cell.constructor
- Defined in src/core/values/num.ts:48

Methods

add

add(b: Val<number>): this
Parameters
- b: Val<number>
Returns this
- Defined in src/core/values/num.ts:52

affine

affine(k: Val<number>, off: Val<number>): this
Affine map v ↦ k·v + off. Invertible when k ≠ 0.
Parameters
- k: Val<number>
- off: Val<number>
Returns this
- Defined in src/core/values/num.ts:74

clamp

clamp(lo: Val<number>, hi: Val<number>): this
Clamp to [lo, hi]. Lossy: a write outside the range reads back clamped.
Parameters
- lo: Val<number>
- hi: Val<number>
Returns this
- Defined in src/core/values/num.ts:106

cyclic

cyclic(period: Val<number>): this
Reads pass through; a write picks the value closest to the current one modulo period, so dragging an angle never jumps a full turn.
Parameters
- period: Val<number>
Returns this
- Defined in src/core/values/num.ts:139

derive

derive(this: Cell<number>, fn: (v: number) => number): this
Read-only same-type view: the RO dual of the endo .lens. For a cross-type view use the typed static Target.derive(src, fn).
Parameters
- this: Cell<number>
- fn: (v: number) => number
Returns this
Inherited from Cell.derive
- Defined in src/core/cell.ts:885

divisibleBy

divisibleBy<T extends Num>(
this: T,
d: Val<number>,
): T extends WritableBrand ? Writable<Bool> : Bool
True when round(this) is divisible by d. A write snaps to the nearest multiple of d to make it divisible, or bumps by 1 to make it not.
Type Parameters
- T extends Num
Parameters
- this: T
- d: Val<number>
Returns T extends WritableBrand ? Writable<Bool> : Bool
- Defined in src/core/values/num.ts:192

exp

exp(): this
Natural exponential; inverts via log.

Returns this
- Defined in src/core/values/num.ts:98

greaterThan

greaterThan<T extends Num>(
 this: T,
 t: Val<number>,
 eps?: Val<number>,
): T extends WritableBrand ? Writable<Bool> : Bool
this > t as a Bool. Flipping it bumps the source across the threshold by eps.
Type Parameters
- T extends Num
Parameters
- this: T
- t: Val<number>
- eps: Val<number> = 1e-6
Returns T extends WritableBrand ? Writable<Bool> : Bool
- Defined in src/core/values/num.ts:153

lens

lens(
 this: Cell<number>,
 fwd: (v: number) => number,
 bwd: (target: number, current: number) => number,
): this
Endomorphic lens. A 2-arg bwd(view, current) consults the current source; a 1-arg bwd(view) reconstructs it from the view alone.
Parameters
- this: Cell<number>
- fwd: (v: number) => number
- bwd: (target: number, current: number) => number
Returns this
Inherited from Cell.lens
- Defined in src/core/cell.ts:879

lessThan

lessThan<T extends Num>(
 this: T,
 t: Val<number>,
 eps?: Val<number>,
): T extends WritableBrand ? Writable<Bool> : Bool
this < t as a Bool.
Type Parameters
- T extends Num
Parameters
- this: T
- t: Val<number>
- eps: Val<number> = 1e-6
Returns T extends WritableBrand ? Writable<Bool> : Bool
- Defined in src/core/values/num.ts:172

merge

merge(this: Cell<number>, fold?: MergeFold<number>): Cell<number>
Backward fan-in: forwards its parent's value unchanged; on write, folds N contributors into one value. fold defaults to last-writer-wins.
Parameters
- this: Cell<number>
- Optionalfold: MergeFold<number>
Returns Cell<number>
Inherited from Cell.merge
- Defined in src/core/cell.ts:914

peek

peek(): number
Returns number
Inherited from Cell.peek
- Defined in src/core/cell.ts:864

quantize

quantize(step: Val<number>): this
Snap reads and writes to the nearest multiple of step (lossy).
Parameters
- step: Val<number>
Returns this
- Defined in src/core/values/num.ts:123

scale

scale(k: Val<number>): this
Parameters
- k: Val<number>
Returns this
- Defined in src/core/values/num.ts:66

sin

sin(): this
Sine of this (radians). The inverse is multi-valued; a write picks the angle nearest the current value, so a drag stays on its branch.

Returns this
- Defined in src/core/values/num.ts:85

sub

sub(b: Val<number>): this
Parameters
- b: Val<number>
Returns this
- Defined in src/core/values/num.ts:59

through

through(this: Cell<number>, o: Optic<number, B>): Writable<Cell>
Apply optic value(s) as a writable lens: c.through(o) ≡ lens(c, o.get, o.put); multiple optics compose left-to-right (c.through(a, b) = a then b). Cross-type, unlike the endomorphic instance .lens.
Type Parameters
- B
Parameters
- this: Cell<number>
- o: Optic<number, B>
Returns Writable<Cell>
Inherited from Cell.through
- Defined in src/core/cell.ts:892
through<B, C>(
 this: Cell<number>,
 o1: Optic<number, B>,
 o2: Optic<B, C>,
): Writable<Cell<C>>
Apply optic value(s) as a writable lens: c.through(o) ≡ lens(c, o.get, o.put); multiple optics compose left-to-right (c.through(a, b) = a then b). Cross-type, unlike the endomorphic instance .lens.
Type Parameters
- B
- C
Parameters
- this: Cell<number>
- o1: Optic<number, B>
- o2: Optic<B, C>
Returns Writable<Cell<C>>
Inherited from Cell.through
- Defined in src/core/cell.ts:893
through<B, C, D>(
 this: Cell<number>,
 o1: Optic<number, B>,
 o2: Optic<B, C>,
 o3: Optic<C, D>,
): Writable<Cell<D>>
Apply optic value(s) as a writable lens: c.through(o) ≡ lens(c, o.get, o.put); multiple optics compose left-to-right (c.through(a, b) = a then b). Cross-type, unlike the endomorphic instance .lens.
Type Parameters
- B
- C
- D
Parameters
- this: Cell<number>
- o1: Optic<number, B>
- o2: Optic<B, C>
- o3: Optic<C, D>
Returns Writable<Cell<D>>
Inherited from Cell.through
- Defined in src/core/cell.ts:894

to

to(
 this: Writable<Num>,
 target: number,
 dur: Val<number>,
 ease?: Easing,
): Tween<number>
Tween-builder.
Parameters
- this: Writable<Num>
- target: number
- dur: Val<number>
- Optionalease: Easing
Returns Tween<number>
- Defined in src/core/values/num.ts:224

`Static`coerce

coerce<C extends AnyCellCtor>(
this: C,
v: Val<Inner<InstanceType<C>>>,
): InstanceType<C>
Coerce Val<Inner<Cls>> → Cls: instance → identity, RO cell → tracked derive, literal → fresh seed.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- v: Val<Inner<InstanceType<C>>>
Returns InstanceType<C>
Inherited from Cell.coerce
- Defined in src/core/cell.ts:987

`Static`derive

derive<C extends AnyCellCtor, P>(
 this: C,
 parent: Read,
 fn: (v: P) => Inner<InstanceType<C>>,
): InstanceType<C>
Read-only typed view. Cls.derive(parent, fn) (1-input), Cls.derive(parents, fn) (N-input), or Cls.derive(fn) (closure). Polymorphic-this: Vec.derive(...) → Vec.
Type Parameters
- C extends AnyCellCtor
- P
Parameters
- this: C
- parent: Read
- fn: (v: P) => Inner<InstanceType<C>>
Returns InstanceType<C>
Inherited from Cell.derive
- Defined in src/core/cell.ts:932
derive<C extends AnyCellCtor, P extends readonly Read<unknown>[]>(
 this: C,
 parents: P,
 fn: (vals: ReadValues) => Inner<InstanceType<C>>,
): InstanceType<C>
Read-only typed view. Cls.derive(parent, fn) (1-input), Cls.derive(parents, fn) (N-input), or Cls.derive(fn) (closure). Polymorphic-this: Vec.derive(...) → Vec.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
Parameters
- this: C
- parents: P
- fn: (vals: ReadValues) => Inner<InstanceType<C>>
Returns InstanceType<C>
Inherited from Cell.derive
- Defined in src/core/cell.ts:937
derive<C extends AnyCellCtor>(
this: C,
fn: () => Inner<InstanceType<C>>,
): InstanceType<C>
Read-only typed view. Cls.derive(parent, fn) (1-input), Cls.derive(parents, fn) (N-input), or Cls.derive(fn) (closure). Polymorphic-this: Vec.derive(...) → Vec.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- fn: () => Inner<InstanceType<C>>
Returns InstanceType<C>
Inherited from Cell.derive
- Defined in src/core/cell.ts:942

`Static`is

is<C extends AnyCellCtor>(this: C, v: unknown): v is InstanceType<C>
Type predicate against this class: Vec.is(x) narrows x to Vec. Inherited static; works for any subclass via polymorphic this.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- v: unknown
Returns v is InstanceType<C>
Inherited from Cell.is
- Defined in src/core/cell.ts:981

`Static`lens

lens<C extends AnyCellCtor, P>(
 this: C,
 parent: Read,
 fwd: (v: P) => Inner<InstanceType<C>>,
 bwd: (target: Inner<InstanceType<C>>, v: P) => P,
): Writable<InstanceType<C>>
Writable lens. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N; a 2-arg bwd reads the source, a 1-arg bwd reconstructs it. Cls.lens(parent(s), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
Type Parameters
- C extends AnyCellCtor
- P
Parameters
- this: C
- parent: Read
- fwd: (v: P) => Inner<InstanceType<C>>
- bwd: (target: Inner<InstanceType<C>>, v: P) => P
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:952
lens<C extends AnyCellCtor, P extends readonly Read<unknown>[]>(
 this: C,
 parents: P,
 fwd: (vals: ReadValues) => Inner<InstanceType<C>>,
 bwd: (
 target: Inner<InstanceType<C>>,
 vals: ReadValues,
 ) => BackUpdates<ReadValuesOrSkip>,
): Writable<InstanceType<C>>
Writable lens. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N; a 2-arg bwd reads the source, a 1-arg bwd reconstructs it. Cls.lens(parent(s), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
Parameters
- this: C
- parents: P
- fwd: (vals: ReadValues) => Inner<InstanceType<C>>
- bwd: (
 target: Inner<InstanceType<C>>,
 vals: ReadValues,
 ) => BackUpdates<ReadValuesOrSkip>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:958
lens<C extends AnyCellCtor, P, Cm>(
 this: C,
 parent: Read,
 spec: StatefulLensSpec1<P, Inner<InstanceType<C>>, Cm>,
): Writable<InstanceType<C>>
Writable lens. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N; a 2-arg bwd reads the source, a 1-arg bwd reconstructs it. Cls.lens(parent(s), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
Type Parameters
- C extends AnyCellCtor
- P
- Cm
Parameters
- this: C
- parent: Read
- spec: StatefulLensSpec1<P, Inner<InstanceType<C>>, Cm>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:964
lens<C extends AnyCellCtor, P extends readonly Read<unknown>[], Cm>(
 this: C,
 parents: P,
 spec: StatefulLensSpec<ReadValues, Inner<InstanceType<C>>, Cm>,
): Writable<InstanceType<C>>
Writable lens. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N; a 2-arg bwd reads the source, a 1-arg bwd reconstructs it. Cls.lens(parent(s), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
- Cm
Parameters
- this: C
- parents: P
- spec: StatefulLensSpec<ReadValues, Inner<InstanceType<C>>, Cm>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:969

`Static`pin

pin<C extends AnyCellCtor>(
this: C,
v: Inner<InstanceType<C>>,
): Writable<InstanceType<C>>
Writable-shaped constant: always reads v, absorbs writes (parentless sink lens), for APIs demanding bidirectionality.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- v: Inner<InstanceType<C>>
Returns Writable<InstanceType<C>>
Inherited from Cell.pin
- Defined in src/core/cell.ts:1000

Properties

`Readonly`_t

_t: {
 equals: (a: number, b: number) => boolean;
 lerp: (a: number, b: number, t: number) => number;
 linear: Linear<number>;
 metric: (a: number, b: number) => number;
 pack: Pack<number>;
}

name

name: string | undefined

Optional debug label (cell(0, { name })); used by errors and graph dumps.

`Readonly`value

value: number

`Static`traits

traits: {
 equals: (a: number, b: number) => boolean;
 lerp: (a: number, b: number, t: number) => number;
 linear: Linear<number>;
 metric: (a: number, b: number) => number;
 pack: Pack<number>;
} = ...

Class Num

Hierarchy

Index

Accessors

Constructors

Methods

Properties

Accessors

isEven

Returns this extends WritableBrand ? Writable<Bool> : Bool

isOdd

Returns this extends WritableBrand ? Writable<Bool> : Bool

Constructors

constructor

Parameters

Returns Num

Methods

add

Parameters

Returns this

affine

Parameters

Returns this

clamp

Parameters

Returns this

cyclic

Parameters

Returns this

derive

Parameters

Returns this

divisibleBy

Type Parameters

Parameters

Returns T extends WritableBrand ? Writable<Bool> : Bool

exp

Returns this

greaterThan

Type Parameters

Parameters

Returns T extends WritableBrand ? Writable<Bool> : Bool

lens

Parameters

Returns this

lessThan

Type Parameters

Parameters

Returns T extends WritableBrand ? Writable<Bool> : Bool

merge

Parameters

Returns Cell<number>

peek

Returns number

quantize

Parameters

Returns this

scale

Parameters

Returns this

sin

Returns this

sub

Parameters

Returns this

through

Type Parameters

Parameters

Returns Writable<Cell<B>>

Type Parameters

Parameters

Returns Writable<Cell<C>>

Type Parameters

Parameters

Returns Writable<Cell<D>>

to

Parameters

Returns Tween<number>

Staticcoerce

Type Parameters

`Static`coerce

`Static`derive

`Static`is

`Static`lens

`Static`pin

`Readonly`_t

`Readonly`value

`Static`traits