Class Field<T>

Type Parameters

Hierarchy

Cell<FieldVal>
- Field (View Summary)

Index

Constructors

constructor

new Field<T>(kind: FieldKind<T>, v?: FieldVal): Field<T>
Type Parameters
- T
Parameters
- kind: FieldKind<T>
- v: FieldVal = EMPTY
Returns Field<T>
Overrides Cell.constructor
- Defined in src/core/values/field.ts:134

Methods

colormap

colormap(channel: number, stops: readonly ColorStop[]): Canvas
Render channel through a colormap to a read-only Canvas; re-renders per epoch.
Parameters
- channel: number
- stops: readonly ColorStop[]
Returns Canvas
- Defined in src/core/values/field.ts:217

derive

derive(this: Cell<FieldVal>, fn: (v: FieldVal) => FieldVal): 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<FieldVal>
- fn: (v: FieldVal) => FieldVal
Returns this
Inherited from Cell.derive
- Defined in src/core/cell.ts:885

evolve

evolve(
 frag: string,
 uniforms?: Record<string, number | readonly number[]>,
 steps?: number,
): void
Step the field by steps GPU passes of frag (which samples the current field as u_src; u_texel = 1/size is provided). One value is committed after the substeps, so the reactive graph sees a single new epoch/frame.
Parameters
- frag: string
- Optionaluniforms: Record<string, number | readonly number[]>
- steps: number = 1
Returns void
- Defined in src/core/values/field.ts:148

lens

lens(
 this: Cell<FieldVal>,
 fwd: (v: FieldVal) => FieldVal,
 bwd: (target: FieldVal, current: FieldVal) => FieldVal,
): 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<FieldVal>
- fwd: (v: FieldVal) => FieldVal
- bwd: (target: FieldVal, current: FieldVal) => FieldVal
Returns this
Inherited from Cell.lens
- Defined in src/core/cell.ts:879

mean

mean(): Read<T>
Whole-field mean as a read-only T cell. Recomputes per epoch; one 1×1 GPU readback.

Returns Read<T>
- Defined in src/core/values/field.ts:188

merge

merge(this: Cell<FieldVal>, fold?: MergeFold<FieldVal>): Cell<FieldVal>
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<FieldVal>
- Optionalfold: MergeFold<FieldVal>
Returns Cell<FieldVal>
Inherited from Cell.merge
- Defined in src/core/cell.ts:914

peek

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

regionMean

regionMean(box: Val<{ h: number; w: number; x: number; y: number }>): Read<T>
Mean over a sub-rectangle (data pixels, reactive box) as a read-only T cell.
Parameters
- box: Val<{ h: number; w: number; x: number; y: number }>
Returns Read<T>
- Defined in src/core/values/field.ts:195

splat

splat(x: number, y: number, r: number, value: T, strength?: number): void
Stamp a Gaussian disc of value at data pixel (x, y), radius r.
Parameters
- x: number
- y: number
- r: number
- value: T
- strength: number = 1
Returns void
- Defined in src/core/values/field.ts:170

through

through(this: Cell<FieldVal>, o: Optic<FieldVal, 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<FieldVal>
- o: Optic<FieldVal, B>
Returns Writable<Cell>
Inherited from Cell.through
- Defined in src/core/cell.ts:892
through<B, C>(
 this: Cell<FieldVal>,
 o1: Optic<FieldVal, 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<FieldVal>
- o1: Optic<FieldVal, 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<FieldVal>,
 o1: Optic<FieldVal, 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<FieldVal>
- o1: Optic<FieldVal, B>
- o2: Optic<B, C>
- o3: Optic<C, D>
Returns Writable<Cell<D>>
Inherited from Cell.through
- Defined in src/core/cell.ts:894

`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: FieldVal, b: FieldVal) => boolean }

`Readonly`kind

kind: FieldKind<T>

name

name: string | undefined

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

`Readonly`value

value: FieldVal

`Static`traits

traits: { equals: (a: FieldVal, b: FieldVal) => boolean } = ...

Class Field<T>

Type Parameters

Hierarchy

Index

Constructors

Methods

Properties

Constructors

constructor

Type Parameters

Parameters

Returns Field<T>

Methods

colormap

Parameters

Returns Canvas

derive

Parameters

Returns this

evolve

Parameters

Returns void

lens

Parameters

Returns this

mean

Returns Read<T>

merge

Parameters

Returns Cell<FieldVal>

peek

Returns FieldVal

regionMean

Parameters

Returns Read<T>

splat

Parameters

Returns void

through

Type Parameters

Parameters

Returns Writable<Cell<B>>

Type Parameters

Parameters

Returns Writable<Cell<C>>

Type Parameters

Parameters

Returns Writable<Cell<D>>

Staticcoerce

Type Parameters

Parameters

Returns InstanceType<C>

Staticderive

Type Parameters

Parameters

Returns InstanceType<C>

Type Parameters

Parameters

Returns InstanceType<C>

Type Parameters

Parameters

Returns InstanceType<C>

Staticis

Type Parameters

Parameters

Returns v is InstanceType<C>

Staticlens

Type Parameters

Parameters

Returns Writable<InstanceType<C>>

Type Parameters

Parameters

Returns Writable<InstanceType<C>>

Type Parameters

Parameters

Returns Writable<InstanceType<C>>

Type Parameters

Parameters

Returns Writable<InstanceType<C>>

Staticpin

`Static`coerce

`Static`derive

`Static`is

`Static`lens

`Static`pin

`Readonly`_t

`Readonly`kind

`Readonly`value

`Static`traits