FSharp.Data.Toolbox


ProvidedMeasureBuilder Type

Helps create erased provided unit-of-measure annotations.

Static members

Static member Description

ProvidedMeasureBuilder.AnnotateType(basic, argument)

Full Usage: ProvidedMeasureBuilder.AnnotateType(basic, argument)

Parameters:
Returns: Type

Returns a type where the type has been annotated with the given types and/or units-of-measure. e.g. float, Vector

basic : Type
argument : Type list
Returns: Type

ProvidedMeasureBuilder.Inverse(denominator)

Full Usage: ProvidedMeasureBuilder.Inverse(denominator)

Parameters:
    denominator : Type

Returns: Type

Returns the measure indicating the inverse of two units of measure, e.g. 1 / s

denominator : Type
Returns: Type

ProvidedMeasureBuilder.One

Full Usage: ProvidedMeasureBuilder.One

Returns: Type

Gets the measure indicating the "1" unit of measure, that is the unitless measure.

Returns: Type

ProvidedMeasureBuilder.Product(measure1, measure2)

Full Usage: ProvidedMeasureBuilder.Product(measure1, measure2)

Parameters:
Returns: Type

Returns the measure indicating the product of two units of measure, e.g. kg * m

measure1 : Type
measure2 : Type
Returns: Type

ProvidedMeasureBuilder.Ratio(numerator, denominator)

Full Usage: ProvidedMeasureBuilder.Ratio(numerator, denominator)

Parameters:
Returns: Type

Returns the measure indicating the ratio of two units of measure, e.g. kg / m

numerator : Type
denominator : Type
Returns: Type

ProvidedMeasureBuilder.SI(unitName)

Full Usage: ProvidedMeasureBuilder.SI(unitName)

Parameters:
    unitName : string

Returns: Type

Returns the measure for an SI unit from the F# core library, where the string is in capitals and US spelling, e.g. Meter

unitName : string
Returns: Type

ProvidedMeasureBuilder.Square(measure)

Full Usage: ProvidedMeasureBuilder.Square(measure)

Parameters:
Returns: Type

Returns the measure indicating the square of a unit of measure, e.g. m * m

measure : Type
Returns: Type