Crystal.WeightedMetrics Class Reference

Calculates the l-p weighted metrics https://en.wikipedia.org/wiki/Lp_space. More...

Inheritance diagram for Crystal.WeightedMetrics:

Public Member Functions
float	Calculate (ICollection< Utility > elements)
	Calculate the l-p weighted metrics measure for the given set of elements. More...
IMeasure	Clone ()
	Creates a new instance of the implementing class. Note that the semantics here are somewhat vague, however, by convention the "Prototype Pattern" uses a "Clone" function. Note that this may have very different semantics when compared with either shallow or deep cloning. When implementing this remember to include only the defining characteristics of the class and not its state! More...
	WeightedMetrics (float pNorm=2f)
	Initializes a new instance of the T:Crystal.WeightedMetrics class. More...
Public Member Functions inherited from Crystal.IAiPrototype< IMeasure >
T	Clone ()
	Creates a new instance of the implementing class. Note that the semantics here are somewhat vague, however, by convention the "Prototype Pattern" uses a "Clone" function. Note that this may have very different semantics when compared with either shallow or deep cloning. When implementing this remember to include only the defining characteristics of the class and not its state! More...

Public Attributes
readonly float	PNormMin = 1.0f
	The minimum value for T:Crystal.ConstrainedWeightedMetrics.PNorm. More...
readonly float	PNormMax = 10000.0f
	The minimum value for T:Crystal.ConstrainedWeightedMetrics.PNorm. More...

Properties
float	PNorm [get, set]
	Gets or sets the p norm used in this instance. More...

Detailed Description

Calculates the l-p weighted metrics https://en.wikipedia.org/wiki/Lp_space.

See also

T:Crystal.IMeasure

Constructor & Destructor Documentation

Crystal.WeightedMetrics.WeightedMetrics ( float  pNorm = 2f )

inline

Initializes a new instance of the T:Crystal.WeightedMetrics class.

Parameters

pNorm

The p norm.

Member Function Documentation

float Crystal.WeightedMetrics.Calculate ( ICollection< Utility >  elements )

inline

Calculate the l-p weighted metrics measure for the given set of elements.

Parameters

elements

Returns

Implements Crystal.IMeasure.

IMeasure Crystal.WeightedMetrics.Clone ( )

inline

Creates a new instance of the implementing class. Note that the semantics here are somewhat vague, however, by convention the "Prototype Pattern" uses a "Clone" function. Note that this may have very different semantics when compared with either shallow or deep cloning. When implementing this remember to include only the defining characteristics of the class and not its state!

Returns

Member Data Documentation

readonly float Crystal.WeightedMetrics.PNormMax = 10000.0f

The minimum value for T:Crystal.ConstrainedWeightedMetrics.PNorm.

readonly float Crystal.WeightedMetrics.PNormMin = 1.0f

The minimum value for T:Crystal.ConstrainedWeightedMetrics.PNorm.

Property Documentation

float Crystal.WeightedMetrics.PNorm

getset

Gets or sets the p norm used in this instance.

---

The documentation for this class was generated from the following file:

• Source/Measures/WeightedMetrics.cs