CDPL.Util.DG2DCoordinatesGenerator Class Reference

Inheritance diagram for CDPL.Util.DG2DCoordinatesGenerator:

Classes
class	DistanceConstraint
class	DistanceConstraintList

Public Member Functions
None	__init__ ()
	Initializes the DG2DCoordinatesGenerator instance.
None	__init__ (DG2DCoordinatesGenerator gen)
	Initializes a copy of the DG2DCoordinatesGenerator instance gen. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
DG2DCoordinatesGenerator	assign (DG2DCoordinatesGenerator gen)
	Replaces the current state of self with a copy of the state of the DG2DCoordinatesGenerator instance gen. More...
None	clearDistanceConstraints ()
int	getNumDistanceConstraints ()
DistanceConstraint	getDistanceConstraint (int idx)
None	addDistanceConstraint (int pt1_idx, int pt2_idx, float lb, float ub)
None	removeDistanceConstraint (int idx)
None	setNumCycles (int num_cycles)
int	getNumCycles ()
None	setCycleStepCountFactor (float fact)
float	getCycleStepCountFactor ()
None	setStartLearningRate (float rate)
float	getStartLearningRate ()
None	setLearningRateDecrement (float decr)
float	getLearningRateDecrement ()
None	setRandomSeed (int seed)
None	generate (int num_points, Math.Vector2DArray coords)
float	getDistanceError (Math.Vector2DArray coords)
DistanceConstraintList	getDistanceConstraints ()

Static Public Attributes
int	COORDS_DIM = 2
int	DEF_NUM_CYCLES = 50
float	DEF_CYCLE_STEP_COUNT_FACTOR = 1.0
float	DEF_START_LEARNING_RATE = 1.0
float	DEF_LEARNING_RATE_DECREMENT = 0.019

Properties
	objectID = property(getObjectID)
	numCycles = property(getNumCycles, setNumCycles)
	cycleStepCountFactor = property(getCycleStepCountFactor, setCycleStepCountFactor)
	startLearningRate = property(getStartLearningRate, setStartLearningRate)
	learningRateDecrement = property(getLearningRateDecrement, setLearningRateDecrement)
	numDistanceConstraints = property(getNumDistanceConstraints)
	distanceConstraints = property(getDistanceConstraints)

Constructor & Destructor Documentation

__init__()

None CDPL.Util.DG2DCoordinatesGenerator.__init__

(

DG2DCoordinatesGenerator

gen

)

Initializes a copy of the DG2DCoordinatesGenerator instance gen.

Parameters

gen	The DG2DCoordinatesGenerator instance to copy.

Member Function Documentation

getObjectID()

int CDPL.Util.DG2DCoordinatesGenerator.getObjectID

(

)

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python DG2DCoordinatesGenerator instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b thus cannot tell reliably whether the two DG2DCoordinatesGenerator instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID().

Returns

The numeric ID of the internally referenced C++ class instance.

assign()

DG2DCoordinatesGenerator CDPL.Util.DG2DCoordinatesGenerator.assign

(

DG2DCoordinatesGenerator

gen

)

Replaces the current state of self with a copy of the state of the DG2DCoordinatesGenerator instance gen.

Parameters

gen	The DG2DCoordinatesGenerator instance to copy.

Returns

self

getNumDistanceConstraints()

int CDPL.Util.DG2DCoordinatesGenerator.getNumDistanceConstraints

(

)

Returns

getDistanceConstraint()

DistanceConstraint CDPL.Util.DG2DCoordinatesGenerator.getDistanceConstraint

(

int

idx

)

Parameters

idx

Returns

addDistanceConstraint()

None CDPL.Util.DG2DCoordinatesGenerator.addDistanceConstraint	(	int	pt1_idx,
		int	pt2_idx,
		float	lb,
		float	ub
	)

Parameters

pt1_idx
pt2_idx
lb
ub

removeDistanceConstraint()

None CDPL.Util.DG2DCoordinatesGenerator.removeDistanceConstraint

(

int

idx

)

Parameters

idx

setNumCycles()

None CDPL.Util.DG2DCoordinatesGenerator.setNumCycles

(

int

num_cycles

)

Parameters

num_cycles

getNumCycles()

int CDPL.Util.DG2DCoordinatesGenerator.getNumCycles

(

)

Returns

setCycleStepCountFactor()

None CDPL.Util.DG2DCoordinatesGenerator.setCycleStepCountFactor

(

float

fact

)

Parameters

fact

getCycleStepCountFactor()

float CDPL.Util.DG2DCoordinatesGenerator.getCycleStepCountFactor

(

)

Returns

setStartLearningRate()

None CDPL.Util.DG2DCoordinatesGenerator.setStartLearningRate

(

float

rate

)

Parameters

rate

getStartLearningRate()

float CDPL.Util.DG2DCoordinatesGenerator.getStartLearningRate

(

)

Returns

setLearningRateDecrement()

None CDPL.Util.DG2DCoordinatesGenerator.setLearningRateDecrement

(

float

decr

)

Parameters

decr

getLearningRateDecrement()

float CDPL.Util.DG2DCoordinatesGenerator.getLearningRateDecrement

(

)

Returns

setRandomSeed()

None CDPL.Util.DG2DCoordinatesGenerator.setRandomSeed

(

int

seed

)

Parameters

seed

generate()

None CDPL.Util.DG2DCoordinatesGenerator.generate	(	int	num_points,
		Math.Vector2DArray	coords
	)

Parameters

num_points
coords

getDistanceError()

float CDPL.Util.DG2DCoordinatesGenerator.getDistanceError

(

Math.Vector2DArray

coords

)

Parameters

coords

Returns

getDistanceConstraints()

DistanceConstraintList CDPL.Util.DG2DCoordinatesGenerator.getDistanceConstraints

(

)

Returns