RandomDirection

class RandomDirection(*args)

Sampling following the random direction strategy.

Available constructor:

RandomDirection()

RandomDirection(dimension)

Parameters

dimensioninteger

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

See also

OrthogonalDirection

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(self)	Generate the sample.
getClassName(self)	Accessor to the object’s name.
getDimension(self)	Accessor to the dimension.
getId(self)	Accessor to the object’s id.
getName(self)	Accessor to the object’s name.
getShadowedId(self)	Accessor to the object’s shadowed id.
getUniformUnitVectorRealization(self, \*args)	Accessor to a realization according to the uniform distribution.
getVisibility(self)	Accessor to the object’s visibility state.
hasName(self)	Test if the object is named.
hasVisibleName(self)	Test if the object has a distinguishable name.
setDimension(self, dimension)	Accessor to the dimension.
setName(self, name)	Accessor to the object’s name.
setShadowedId(self, id)	Accessor to the object’s shadowed id.
setVisibility(self, visible)	Accessor to the object’s visibility state.

__init__(self, \*args)

Initialize self. See help(type(self)) for accurate signature.

generate(self)

Generate the sample.

Returns

sampleSample

The sample generated in two opposite random directions.

getClassName(self)

Accessor to the object’s name.

Returns

class_namestr

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

getDimension(self)

Accessor to the dimension.

Returns

dimensionint

Dimension of the standard space.

getId(self)

Accessor to the object’s id.

Returns

idint

Internal unique identifier.

getName(self)

Accessor to the object’s name.

Returns

namestr

The name of the object.

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns

idint

Internal unique identifier.

getUniformUnitVectorRealization(self, \*args)

Accessor to a realization according to the uniform distribution.

Parameters

dimensionint

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

Returns

samplePoint

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

getVisibility(self)

Accessor to the object’s visibility state.

Returns

visiblebool

Visibility flag.

hasName(self)

Test if the object is named.

Returns

hasNamebool

True if the name is not empty.

hasVisibleName(self)

Test if the object has a distinguishable name.

Returns

hasVisibleNamebool

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

setDimension(self, dimension)

Accessor to the dimension.

Parameters

dimensionint

Dimension of the standard space.

setName(self, name)

Accessor to the object’s name.

Parameters

namestr

The name of the object.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

Parameters

idint

Internal unique identifier.

setVisibility(self, visible)

Accessor to the object’s visibility state.

Parameters

visiblebool

Visibility flag.