[Home] Module Microsoft.FSharp.Core.LanguagePrimitives


Modules (as contributed by assembly 'FSharp.Core')

ModuleDescription
Microsoft.FSharp.Core.LanguagePrimitives.HashCompare
Microsoft.FSharp.Core.LanguagePrimitives.IntrinsicFunctions
Microsoft.FSharp.Core.LanguagePrimitives.IntrinsicOperators Compiler-recognized operators

Values

ValueDescription
val DefaultValue< ^a when  ^a : null> :  ^a when  ^a : null
Generate a null value for reference types.
val EnumOfValue : 'u -> 'e when 'e : enum<'u>
Build an enum value from an underlying value.
val EnumToValue : 'e -> 'u when 'e : enum<'u>
val GenericComparison : 'a -> 'a -> int
Compare two values
val GenericEquality : 'a -> 'a -> bool
Compare two values for equality
val GenericGreaterOrEqual : 'a -> 'a -> bool
Compare two values
val GenericGreaterThan : 'a -> 'a -> bool
Compare two values
val GenericHash : 'a -> int
val GenericLessOrEqual : 'a -> 'a -> bool
Compare two values
val GenericLessThan : 'a -> 'a -> bool
Compare two values
val GenericMaximum : 'a -> 'a -> 'a
Take the maximum of two values structurally according to the order given by GenericComparison
val GenericMinimum : 'a -> 'a -> 'a
Take the minimum of two values structurally according to the order given by GenericComparison
val PhysicalEquality : 'a -> 'a -> bool
Reference/physical equality. True if boxed versions of the inputs are reference-equal, OR if both are primitive numeric types and the implementation of Object.Equals for the type of the first argument returns true on the boxed versions of the inputs.
val PhysicalHash : 'a -> int
The physical hash. Hashes on the object identity, except for value types, where we hash on the contents.

Deprecated Values

ValueDescription
[<Obsolete ("Use GenericHash instead")>]
val GenericHashParam : 'a -> int byref -> int

Note: Use GenericHash instead

Hash a value according to its structure. See the IStructuralHash interface. Implementations of IStructuralHash for aggregate structured data structures should call this function to hash sub-structures. The byref argument points to a count of the number of significant nodes remaining to be hashed in the cooperative hash. Substructures and leaf nodes (such as integers) should be hashed by calling Microsoft.FSharp.Core.LanguagePrimitives.GenericHashParam, but only if the hash count is non-zero. If the hash count is zero GenericHashParam must not be called.
[<Obsolete ("Use 'not(GenericEquality x y)' instead")>]
val GenericInequality : 'a -> 'a -> bool

Note: Use 'not(GenericEquality x y)' instead

Compare two values for disequality
[<Obsolete ("Use 'not(PhysicalEquality x y)' instead")>]
val PhysicalInequality : 'a -> 'a -> bool

Note: Use 'not(PhysicalEquality x y)' instead

Reference/physical disequality (not equals) False if boxed versions of the inputs are reference-equal, OR if both are primitive numeric types and the implementation of Object.Equals for the type of the first argument returns true on the boxed versions of the inputs.
[<Obsolete ("This function has been renamed to GenericComparison")>]
val StructuralComparison : 'a -> 'a -> int

Note: This function has been renamed to GenericComparison

[<Obsolete ("This function has been renamed to GenericEquality")>]
val StructuralEquality : 'a -> 'a -> bool

Note: This function has been renamed to GenericEquality

[<Obsolete ("This function has been renamed to GenericGreaterOrEqual")>]
val StructuralGreaterOrEqual : 'a -> 'a -> bool

Note: This function has been renamed to GenericGreaterOrEqual

[<Obsolete ("This function has been renamed to GenericGreaterThan")>]
val StructuralGreaterThan : 'a -> 'a -> bool

Note: This function has been renamed to GenericGreaterThan

[<Obsolete ("This function has been renamed to GenericHash")>]
val StructuralHash : 'a -> int

Note: This function has been renamed to GenericHash

[<Obsolete ("This function has been renamed to GenericHashParam")>]
val StructuralHashParam : 'a -> int byref -> int

Note: This function has been renamed to GenericHashParam

[<Obsolete ("Use 'not(GenericEquality x y)' instead")>]
val StructuralInequality : 'a -> 'a -> bool

Note: Use 'not(GenericEquality x y)' instead

[<Obsolete ("This function has been renamed to GenericLessOrEqual")>]
val StructuralLessOrEqual : 'a -> 'a -> bool

Note: This function has been renamed to GenericLessOrEqual

[<Obsolete ("This function has been renamed to GenericLessThan")>]
val StructuralLessThan : 'a -> 'a -> bool

Note: This function has been renamed to GenericLessThan

[<Obsolete ("This function has been renamed to GenericMaximum")>]
val StructuralMaximum : 'a -> 'a -> 'a

Note: This function has been renamed to GenericMaximum

[<Obsolete ("This function has been renamed to GenericMinimum")>]
val StructuralMinimum : 'a -> 'a -> 'a

Note: This function has been renamed to GenericMinimum

See Also

Microsoft.FSharp.Core


Documentation for assembly FSharp.Core, version 1.9.4.19, generated using F# version 1.9.4.19