import CPMEvol from 'Artistoo/src/models/CPMEvol.js'

public class | source

CPMEvol

Extends:

GridBasedModel → CPM → CPMEvol

Extension of the CPM class that uses Cell objects to track internal state of Cells Cell objects can override conf parameters, and track their lineage.

Constructor Summary

Public Constructor
public	constructor(field_size: GridSize, conf: object) The constructor of class CA.

Member Summary

Public Members
public	cellclasses: CellObject Store the constructor of each cellKind on the grid, in order 0th index currently unused - but this is explicitly left open for further extension (granting background variable parameters through Cell)
public	cells: Cell Store the {@Cell} of each cell on the grid.

Method Summary

Public Methods
public	birth(childId: CellId, parentId: CellId) Calls a birth event in a new daughter Cell object, and hands the other daughter (as parent) on to the Cell.
public	cellDeath(i: IndexCoordinate, t_old: CellId, t_new: CellId) The postSetpixListener of CPMEvol registers cell death.
public	getCell(t: CellId): Cell Get the Cell of the cell with CellId t.
public	makeNewCellID(kind: CellKind): CellId Initiate a new CellId for a cell of CellKind "kind", and create elements for this cell in the relevant arrays.
public	reset() Completely reset; remove all cells and set time back to zero.

Inherited Summary

From class GridBasedModel
public	cellvolume: *[] This tracks the volumes of all non-background cells on the grid.
public	conf: object Input parameter settings; see the constructor of subclasses documentation.
public	extents: GridSize Size of the grid.
public	field_size: object Size of the grid in object format.
public	grid: *
public	midpoint: ArrayCoordinate Midpoint of the grid.
public	mt: MersenneTwister Attach a random number generation with a seed.
public	ndim: number Dimensionality of the grid
public	neighi: function The Grid2D#neighi or Grid3D#neighi iterator function of the underlying grid.
public	pixels: function The Grid2D#pixels or Grid3D#pixels iterator function of the underlying grid.
public	pixti: function The Grid#pixti iterator function of the underlying grid.
public	stat_values: object Cached values of these stats.
public	stats: Stat Objects of class Stat that have been computed on this model.
public	time: number Tracks the elapsed time in MCS
public	* cellIDs(): CellId Iterator for all the CellIds that are currently on the grid.
public	cellKind(t: CellId): CellKind Get the CellKind of the cell with CellId t.
public	getStat(s: Stat): anything Compute a statistic on this model.
public	neigh(p: ArrayCoordinate, torus: boolean[]): * Get neighbourhood of position p, using neighborhood functions of the underlying grid class.
public	pixt(p: ArrayCoordinate): CellId Get CellId of the pixel at coordinates p.
public	ran(incl_min: number, incl_max: number): number Get a random integer number between incl_min and incl_max, uniformly sampled.
public	random(): number Get a random number from the seeded number generator.
public	setpix(p: ArrayCoordinate, t: CellId) Change the pixel at position p into CellId t.
public	setpixi(i: IndexCoordinate, t: CellId) Change the pixel at position i into CellId t.
public abstract	timeStep() Update the grid in one timestep.

From class CPM
public get	perimeterNeighbours: *
public	borderpixels: DiceSet track border pixels for speed
public	cellvolume: *[]
public	hard_constraints: Array Array of objects of (@link HardConstraint) subclasses attached to the CPM.
public	hard_constraints_indices: object Object showing which constraints are where in soft_constraints.
public	isCPM: boolean To check from outside if an object is a CPM; doing this with instanceof doesn't work in some cases. Any other object will not have this variable and return 'undefined', which in an if-statement equates to a 'false'. @type{boolean}
public	last_cell_id: number Highest cell ID previously assigned.
public	nr_cells: number Number of non-background cells currently on the grid.
public	post_mcs_listeners: function[] Array of functions that need to be executed after every timeStep event.
public	post_setpix_listeners: function[] Array of functions that need to be executed after every setpixi event.
public	soft_constraints: Array Array of objects of (@link SoftConstraint) subclasses attached to the CPM.
public	soft_constraints_indices: object Object showing which constraints are where in soft_constraints.
public	stat_values: {}
public	t2k: CellObject Store the {@CellKind} of each cell on the grid.
public	time: number Track time in MCS.
private	_neighbours: Uint16Array Private property used by updateborderneari to track borders.
public	add(t: Constraint) Add a constraint to the CPM, ensuring that its SoftConstraint#deltaH or HardConstraint#fulfilled methods are called appropriately during a copy attempt.
public	* cellBorderPixelIndices(): iPixel Iterator returning non-background border pixels on the grid.
public	* cellBorderPixels(): Pixel Iterator returning non-background border pixels on the grid.
public	cellKind(t: CellId): CellKind Get the CellKind of the cell with CellId t.
public	* cellPixels(): Pixel Iterator returning non-background pixels on the grid.
public	deltaH(sourcei: IndexCoordinate, targeti: IndexCoordinate, src_type: CellId, tgt_type: CellId): number returns total change in hamiltonian for all registered soft constraints together.
public	docopy(deltaH: number): boolean Determine whether copy attempt will succeed depending on deltaH (stochastic).
public	getAllConstraints(): *
public	getConstraint(constraintname: string, num: number): * Get a Constraint object linked to this CPM by the name of its class.
public	getVolume(t: CellId): number Get volume of the cell with CellId t
public	makeNewCellID(kind: CellKind): CellId Initiate a new CellId for a cell of CellKind "kind", and create elements for this cell in the relevant arrays (cellvolume, t2k).
public	monteCarloStep() Simulate one Monte Carlo Step.
public	pixt(p: ArrayCoordinate): CellId Get CellId of the pixel at coordinates p.
public	reset() Completely reset; remove all cells and set time back to zero.
public	setCellKind(t: CellId, k: CellKind) Assign the cell with CellId t to CellKind k.
public	setpixi(i: IndexCoordinate, t: CellId) Change the pixel at position i into CellId t.
public	timeStep() A time step in the CPM is a Monte Carlo step.
public	updateborderneari(i: IndexCoordinate, t_old: CellId, t_new: CellId) Update border elements (borderpixels) after a successful copy attempt.

Public Constructors

public constructor(field_size: GridSize, conf: object) source

The constructor of class CA.

Override:

CPM#constructor

Params:

Name	Type	Attribute	Description
field_size	GridSize		the size of the grid of the model.
conf	object		configuration options; see CPM base class.
conf.CELLS	object[]	optional default: [empty, CPM.Cell, CPM.StochasticCorrector]	Array of objects of (@link Cell) subclasses attached to the CPM. These define the internal state of the cell objects that are tracked

Public Members

public cellclasses: CellObject source

Store the constructor of each cellKind on the grid, in order 0th index currently unused - but this is explicitly left open for further extension (granting background variable parameters through Cell)

public cells: Cell source

Store the {@Cell} of each cell on the grid.

Example:

this.cells[1] // cell object of cell with cellId 1

Public Methods

public birth(childId: CellId, parentId: CellId) source

Calls a birth event in a new daughter Cell object, and hands the other daughter (as parent) on to the Cell.

Params:

Name	Type	Attribute	Description
childId	CellId		id of the newly created Cell object
parentId	CellId		id of the other daughter (that kept the parent id)

public cellDeath(i: IndexCoordinate, t_old: CellId, t_new: CellId) source

The postSetpixListener of CPMEvol registers cell death.

Params:

Name	Type	Attribute	Description
i	IndexCoordinate		the coordinate of the pixel that is changed.
t_old	CellId		the cellid of this pixel before the copy
t_new	CellId		the cellid of this pixel after the copy.

Listen:

setpixi

as this records when cels no longer contain any pixels. Note: CPM class already logs most of death, so it registers deleted entries.

public getCell(t: CellId): Cell source

Get the Cell of the cell with CellId t.

Params:

Name	Type	Attribute	Description
t	CellId		id of the cell to get kind of.

Return:

Cell	the cell object.

public makeNewCellID(kind: CellKind): CellId source

Initiate a new CellId for a cell of CellKind "kind", and create elements for this cell in the relevant arrays. Overrides super to also add a new Cell object to track.

Override:

CPM#makeNewCellID

Params:

Name	Type	Attribute	Description
kind	CellKind		cellkind of the cell that has to be made.

Return:

CellId

newid of the new cell.

public reset() source

Completely reset; remove all cells and set time back to zero. Only the constraints and empty cell remain.

Override:

CPM#reset