import BarrierConstraint from 'Artistoo/src/hamiltonian/BarrierConstraint.js'

public class | source

BarrierConstraint

Extends:

Constraint → HardConstraint → BarrierConstraint

This constraint allows a "barrier" celltype from and into which copy attempts are forbidden.

Example:

// Build a CPM and add the constraint
let CPM = require( "path/to/build" )
let C = new CPM.CPM( [200,200], {
	T : 20,
	J : [[0,0,20],[0,0,5],[20,5,10]],
	V : [0,0,500],
	LAMBDA_V : [0,0,5],
})
C.add( new CPM.BarrierConstraint( {
	IS_BARRIER : [false,true,false]
} ) )

// OR: add automatically by entering the parameters in the CPM
C = new CPM.CPM( [200,200], {
	T : 20,
	J : [[0,0,20],[0,0,5],[20,5,10]],
	V : [0,0,500],
	LAMBDA_V : [0,0,5],
	IS_BARRIER : [false,true,false]
})

// Make a horizontal line barrier (cellkind 1 )
let cid = C.makeNewCellID( 1 )
for( let x = 0; x < 200; x++ ){
	C.setpix( [x,95], cid )
}
// Seed a cell (cellkind2)
let gm = new CPM.GridManipulator( C )
gm.seedCell(2)

Constructor Summary

Public Constructor
public	constructor(conf: object) The constructor of the BarrierConstraint requires a conf object with a single parameter.

Method Summary

Public Methods
public	confChecker() This method checks that all required parameters are present in the object supplied to the constructor, and that they are of the right format.
public	fulfilled(src_i: IndexCoordinate, tgt_i: IndexCoordinate, src_type: CellId, tgt_type: CellId): boolean Method for hard constraints to compute whether the copy attempt fulfills the rule.

Inherited Summary

From class Constraint
public get abstract	CONSTRAINT_TYPE This method is actually implemented in the subclass.
public set	CPM(C: CPM) This function attaches the relevant CPM to this constraint, so that information about this cpm can be requested from the constraint.
public get	parameters: object: * Get the parameters of this constraint from the conf object.
public	C: CPM CPM on which this constraint acts.
public	conf: object Configuration object for this constraint.
public abstract	cellParameter(param: string, cid: CellId): any Get a cellid or cellkind-specific parameter for a constraint.
public abstract	confChecker() The optional confChecker method should verify that all the required conf parameters are actually present in the conf object and have the right format.
public	paramOfCell(param: string, cid: CellId): any Get a cellId specific parameter, only used if CPMEvol is used: looks whether the requested parameter is overwritten in an @object Cell and otherwise returns @function paramOfKind
public	paramOfKind(param: string, cid: CellId): any Returns a cellKind specfic variable: Assumes that the parameter is indexable by cellkind.

From class HardConstraint
public get	CONSTRAINT_TYPE: string: string Let the CPM know that this is a soft constraint, so return 'soft'.
public abstract	fulfilled(src_i: IndexCoordinate, tgt_i: IndexCoordinate, src_type: CellId, tgt_type: CellId): boolean Hard constraints must have a 'fulfilled' method to compute whether the copy attempt fulfills the rule.

Public Constructors

public constructor(conf: object) source

The constructor of the BarrierConstraint requires a conf object with a single parameter.

Override:

Constraint#constructor

Params:

Name	Type	Attribute	Description
conf	object		parameter object for this constraint.
conf.IS_BARRIER	PerKindBoolean		specify for each cellkind if it should be considered as a barrier. If so, all copy attempts into and from it are forbidden.

Public Methods

public confChecker() source

This method checks that all required parameters are present in the object supplied to the constructor, and that they are of the right format. It throws an error when this is not the case.

Override:

Constraint#confChecker

public fulfilled(src_i: IndexCoordinate, tgt_i: IndexCoordinate, src_type: CellId, tgt_type: CellId): boolean source

Method for hard constraints to compute whether the copy attempt fulfills the rule.

Override:

HardConstraint#fulfilled

Params:

Name	Type	Attribute	Description
src_i	IndexCoordinate		coordinate of the source pixel that tries to copy.
tgt_i	IndexCoordinate		coordinate of the target pixel the source is trying to copy into.
src_type	CellId		cellid of the source pixel.
tgt_type	CellId		cellid of the target pixel.

Return:

boolean

whether the copy attempt satisfies the constraint.