RandomDirection

class RandomDirection(*args)

Directions sampling following the random direction strategy.

Parameters:
dimensionint

The dimension of the standard space.

By default, dimension = 0 but automatically updated by the calling class.

Methods

generate()

Generate the directions.

getClassName()

Accessor to the object's name.

getDimension()

Accessor to the dimension.

getName()

Accessor to the object's name.

getUniformUnitVectorRealization(*args)

Accessor to a realization according to the uniform distribution.

hasName()

Test if the object is named.

setDimension(dimension)

Accessor to the dimension.

setName(name)

Accessor to the object's name.

Notes

The random direction strategy generates some directions in the standard space according to the following steps:

  • we generate some points on the sphere unity in the standard space according to the uniform distribution,

  • we consider both opposite directions so built.

Thus, this process generates 2 directions.

__init__(*args)
generate()

Generate the directions.

Returns:
sampleSample

Both directions generated according to the strategy.

Notes

The sample is the collection of the points on the unit sphere in the standard space associated to the generated directions.

getClassName()

Accessor to the object’s name.

Returns:
class_namestr

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

getDimension()

Accessor to the dimension.

Returns:
dimensionint

Dimension of the standard space.

getName()

Accessor to the object’s name.

Returns:
namestr

The name of the object.

getUniformUnitVectorRealization(*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.

hasName()

Test if the object is named.

Returns:
hasNamebool

True if the name is not empty.

setDimension(dimension)

Accessor to the dimension.

Parameters:
dimensionint

Dimension of the standard space.

setName(name)

Accessor to the object’s name.

Parameters:
namestr

The name of the object.

Examples using the class

Use the Adaptive Directional Stratification Algorithm

Use the Adaptive Directional Stratification Algorithm