Crystal AI  1.0.0
Crystal.ConstrainedWeightedMetrics Class Reference

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

Inheritance diagram for Crystal.ConstrainedWeightedMetrics:
Crystal.IMeasure Crystal.IAiPrototype< IMeasure >

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...
 
 ConstrainedWeightedMetrics ()
 Initializes a new instance of the T:Crystal.ConstrainedWeightedMetrics class. More...
 
 ConstrainedWeightedMetrics (float pNorm, float lowerBound=0f)
 Initializes a new instance of the T:Crystal.ConstrainedWeightedMetrics class. More...
 
- Public Member Functions inherited from Crystal.IAiPrototype< 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...
 

Properties

float PNormMin [get]
 The minimum value for T:Crystal.ConstrainedWeightedMetrics.PNorm. More...
 
float PNormMax [get]
 The maximum value for T:Crystal.ConstrainedWeightedMetrics.PNorm. More...
 
float PNorm [get, set]
 Gets or sets the p norm used in this instance. More...
 
float LowerBound [get, set]
 If the combined value of any utility is below this, the value of this measure will be 0. More...
 

Detailed Description

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

See also
T:Crystal.IMeasure

Constructor & Destructor Documentation

Crystal.ConstrainedWeightedMetrics.ConstrainedWeightedMetrics ( )
inline

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

Crystal.ConstrainedWeightedMetrics.ConstrainedWeightedMetrics ( float  pNorm,
float  lowerBound = 0f 
)
inline

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

Parameters
pNormThe p norm.
lowerBoundThe lower bound.

Member Function Documentation

float Crystal.ConstrainedWeightedMetrics.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.ConstrainedWeightedMetrics.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

Property Documentation

float Crystal.ConstrainedWeightedMetrics.LowerBound
getset

If the combined value of any utility is below this, the value of this measure will be 0.

float Crystal.ConstrainedWeightedMetrics.PNorm
getset

Gets or sets the p norm used in this instance.

float Crystal.ConstrainedWeightedMetrics.PNormMax
get

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

float Crystal.ConstrainedWeightedMetrics.PNormMin
get

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


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