import Connectedness from 'Artistoo/src/stats/Connectedness.js'
public class | source

Connectedness

Extends:

Stat → Connectedness

This Stat computes the 'connectedness' of cells on the grid. Keys are the CellId of all cells on the grid, corresponding values the connectedness of the corresponding cell.

Example:

let CPM = require( "path/to/build" )

// Make a CPM, seed a cell, and get the Connectedness
let C = new CPM.CPM( [100,100], { 
	T:20,
	J:[[0,20],[20,10]],
	V:[0,200],
	LAMBDA_V:[0,2]
} )
let gm = new CPM.GridManipulator( C )
gm.seedCell(1)
for( let t = 0; t < 100; t++ ){ C.timeStep() }
C.getStat( CPM.Connectedness )

Method Summary

Public Methods
public

The compute method of Connectedness creates an object with connectedness of each cell on the grid.

public

This method computes the connectedness of a specific cell.

Inherited Summary

From class Stat
public set

Every stat is linked to a specific model.

public

The model to compute the stat on.

public

Configuration object for the stat, which should not change its value but may be used for logging and debugging options.

public abstract

The compute method of the base Stat class throws an error, enforcing that you have to implement this method when you build a new stat class extending this base class.

Public Methods

public compute(): CellObject source

The compute method of Connectedness creates an object with connectedness of each cell on the grid.

Override:

Stat#compute

Return:

CellObject

object with for each cell on the grid a connectedness value.

public connectednessOfCell(cellid: *): number source

This method computes the connectedness of a specific cell.

Params:

NameTypeAttributeDescription
cellid *

Return:

number

the connectedness value of this cell, a number between 0 and 1.