Domain

class Domain(*args)

Base class for domain objects.

Notes

A Domain object can be created through its derived classes:

Methods

computeDistance(*args)

Compute the Euclidean distance of a given point to the domain.

contains(*args)

Check if the given point is inside of the domain.

getClassName()

Accessor to the object's name.

getDimension()

Get the dimension of the domain.

getId()

Accessor to the object's id.

getImplementation()

Accessor to the underlying implementation.

getName()

Accessor to the object's name.

setName(name)

Accessor to the object's name.
__init__(*args)
computeDistance(*args)

Compute the Euclidean distance of a given point to the domain.

Parameters
point or samplesequence of float or 2-d sequence of float

Point or Sample with the same dimension as the current domain’s dimension.

Returns
distancefloat or Sample

Euclidean distance of the point to the domain.

contains(*args)

Check if the given point is inside of the domain.

Parameters
point or samplesequence of float or 2-d sequence of float

Point or Sample with the same dimension as the current domain’s dimension.

Returns
isInsidebool or sequence of bool

Flag telling whether the given point is inside of the domain.

getClassName()

Accessor to the object’s name.

Returns
class_namestr

The object class name (object.__class__.__name__).

getDimension()

Get the dimension of the domain.

Returns
dimint

Dimension of the domain.

getId()

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getImplementation()

Accessor to the underlying implementation.

Returns
implImplementation

The implementation class.

getName()

Accessor to the object’s name.

Returns
namestr

The name of the object.

setName(name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.