RandomDirection

class RandomDirection(*args)

Sampling following the random direction strategy.

Available constructor:

RandomDirection()

RandomDirection(dimension)

Parameters:

dimension : integer

The dimension of the standard space. By default, dimension = 0 but automatically updated by the calling class.

Notes

The RandomDirection strategy is the following : we generate some points on the sphere unity in the standard space according to the uniform distribution and we consider both opposite directions so built.

Methods

generate() Generate the sample.
getClassName() Accessor to the object’s name.
getDimension() Accessor to the dimension.
getId() Accessor to the object’s id.
getName() Accessor to the object’s name.
getShadowedId() Accessor to the object’s shadowed id.
getUniformUnitVectorRealization(*args) Accessor to a realization according to the uniform distribution.
getVisibility() Accessor to the object’s visibility state.
hasName() Test if the object is named.
hasVisibleName() Test if the object has a distinguishable name.
setDimension(dimension) Accessor to the dimension.
setName(name) Accessor to the object’s name.
setShadowedId(id) Accessor to the object’s shadowed id.
setVisibility(visible) Accessor to the object’s visibility state.
__init__(*args)
generate()

Generate the sample.

Returns:

sample : NumericalSample

The sample generated in two opposite random directions.

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

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

getDimension()

Accessor to the dimension.

Returns:

dimension : int

Dimension of the standard space.

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

getUniformUnitVectorRealization(*args)

Accessor to a realization according to the uniform distribution.

Parameters:

dimension : int

The dimension of the sphere unity (which is the dimension of the standard space).

Returns:

sample : NumericalPoint

The realization of a vector on the sphere unity, according to the uniform distribution.

getVisibility()

Accessor to the object’s visibility state.

Returns:

visible : bool

Visibility flag.

hasName()

Test if the object is named.

Returns:

hasName : bool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:

hasVisibleName : bool

True if the name is not empty and not the default one.

setDimension(dimension)

Accessor to the dimension.

Parameters:

dimension : int

Dimension of the standard space.

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:

id : int

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:

visible : bool

Visibility flag.