SpaceFillingMinDist

class SpaceFillingMinDist(*args)

Space filling minimal distance criterion.

Notes

Compute the minimal distance of sample points

Methods

evaluate(self, sample)	Compute the MinDist criterion for a specific design.
getClassName(self)	Accessor to the object’s name.
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.
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.
isMinimizationProblem(self)	Minimization flag accessor.
perturbLHS(self, oldDesign, oldCriterion, …)	Elementary perturbation.
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.

evaluate(self, sample)

Compute the MinDist criterion for a specific design.

Parameters

designSample or 2-d array like

The design

Returns

critfloat

The MinDist criterion

Examples

>>> import openturns as ot
>>> # Build an LHS using openturns class
>>> lhs = ot.LHSExperiment(ot.Uniform(), 100)
>>> design = lhs.generate()
>>> # Compute the MinDist criterion
>>> crit = ot.SpaceFillingMinDist().evaluate(design)

getClassName(self)

Accessor to the object’s name.

Returns

class_namestr

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

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.

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.

isMinimizationProblem(self)

Minimization flag accessor.

Returns

isMinimizationbool

Whether the problem is a minimization.

perturbLHS(self, oldDesign, oldCriterion, row1, row2, column)

Elementary perturbation.

Parameters

designSample

The design to perturb (in-place)

oldCriterionfloat

The previous value of the criterion

row1int

First row index

row2int

Second row index

Returns

criterionfloat

The value of the criterion

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.