If you're new to this library or functional-programming this is almost certainly not the place to start browsing!
Class-instances try to replicate the instances of Haskell in C#. They pair with the traits using ad-hoc polymorphism.
Ad-hoc polymorphism has long been believed to not be possible in C#. However with some cunning it is. Ad-hoc polymorphism allows
programmers to add traits to a type later. For example in C# it would be amazing if we had an interface called INumeric for numeric
types like int, long, double, etc. The reason this doesn't exist is if you write a function like:
INumeric Add(INumeric x, INumeric y) => x + y;
Then it would cause boxing. Which is slow (well, slower). I can only assume that's why it wasn't added by the BCL team. Anyway, it's possible to create a numeric type, very much like a trait in Haskell, and ad-hoc instances of the numeric trait that allow for generic numeric operations without boxing. See the wiki for a deeper dive into ad-hoc polymorphism
Contents
- TBigInt
 - Equals (bigint x, bigint y)
 - Compare (bigint x, bigint y)
 - Add (bigint x, bigint y)
 - Subtract (bigint x, bigint y)
 - Multiply (bigint x, bigint y)
 - Divide (bigint x, bigint y)
 - Abs (bigint x)
 - Signum (bigint x)
 - FromInteger (int x)
 - FromDecimal (decimal x)
 - FromFloat (float x)
 - FromDouble (double x)
 - Empty
 - Negate (bigint x)
 - Append (bigint x, bigint y)
 - GetHashCode (bigint x)
 - True ()
 - False ()
 - And (bigint a, bigint b)
 - Or (bigint a, bigint b)
 - Not (bigint a)
 - XOr (bigint a, bigint b)
 - Implies (bigint a, bigint b)
 - BiCondition (bigint a, bigint b)
 - TBool
 - And (bool a, bool b)
 - Compare (bool x, bool y)
 - Equals (bool x, bool y)
 - False ()
 - GetHashCode (bool x)
 - Not (bool a)
 - Or (bool a, bool b)
 - True ()
 - XOr (bool a, bool b)
 - Implies (bool a, bool b)
 - BiCondition (bool a, bool b)
 - TBoolBool
 - And ((bool, bool) a, (bool, bool) b)
 - Compare ((bool, bool) x, (bool, bool) y)
 - Equals ((bool, bool) x, (bool, bool) y)
 - False ()
 - GetHashCode ((bool, bool) x)
 - Not ((bool, bool) a)
 - Or ((bool, bool) a, (bool, bool) b)
 - True ()
 - XOr ((bool, bool) a, (bool, bool) b)
 - Implies ((bool, bool) a, (bool, bool) b)
 - BiCondition ((bool, bool) a, (bool, bool) b)
 - TChar
 - Equals (char x, char y)
 - Compare (char x, char y)
 - GetHashCode (char x)
 - Add (char x, char y)
 - Subtract (char x, char y)
 - Multiply (char x, char y)
 - Negate (char x)
 - TDecimal
 - Equals (decimal x, decimal y)
 - Compare (decimal x, decimal y)
 - Add (decimal x, decimal y)
 - Subtract (decimal x, decimal y)
 - Multiply (decimal x, decimal y)
 - Divide (decimal x, decimal y)
 - Abs (decimal x)
 - Signum (decimal x)
 - FromInteger (int x)
 - FromDecimal (decimal x)
 - FromFloat (float x)
 - FromDouble (double x)
 - FromRational (Ratio<int> x)
 - Pi ()
 - Exp (decimal x)
 - Sqrt (decimal x)
 - Log (decimal x)
 - Pow (decimal x, decimal y)
 - LogBase (decimal b, decimal x)
 - Sin (decimal x)
 - Cos (decimal x)
 - Tan (decimal x)
 - Asin (decimal x)
 - Acos (decimal x)
 - Atan (decimal x)
 - Sinh (decimal x)
 - Cosh (decimal x)
 - Tanh (decimal x)
 - Asinh (decimal x)
 - Acosh (decimal x)
 - Atanh (decimal x)
 - Negate (decimal x)
 - GetHashCode (decimal x)
 - TDouble
 - Equals (double x, double y)
 - Compare (double x, double y)
 - Add (double x, double y)
 - Subtract (double x, double y)
 - Multiply (double x, double y)
 - Divide (double x, double y)
 - Abs (double x)
 - Signum (double x)
 - FromInteger (int x)
 - FromDecimal (decimal x)
 - FromFloat (float x)
 - FromDouble (double x)
 - FromRational (Ratio<int> x)
 - Pi ()
 - Exp (double x)
 - Sqrt (double x)
 - Log (double x)
 - Pow (double x, double y)
 - LogBase (double b, double x)
 - Sin (double x)
 - Cos (double x)
 - Tan (double x)
 - Asin (double x)
 - Acos (double x)
 - Atan (double x)
 - Sinh (double x)
 - Cosh (double x)
 - Tanh (double x)
 - Asinh (double x)
 - Acosh (double x)
 - Atanh (double x)
 - Negate (double x)
 - GetHashCode (double x)
 - TFloat
 - Equals (float x, float y)
 - Compare (float x, float y)
 - Add (float x, float y)
 - Subtract (float x, float y)
 - Multiply (float x, float y)
 - Divide (float x, float y)
 - Abs (float x)
 - Signum (float x)
 - FromInteger (int x)
 - FromDecimal (decimal x)
 - FromFloat (float x)
 - FromDouble (double x)
 - FromRational (Ratio<int> x)
 - Pi ()
 - Exp (float x)
 - Sqrt (float x)
 - Log (float x)
 - Pow (float x, float y)
 - LogBase (float b, float x)
 - Sin (float x)
 - Cos (float x)
 - Tan (float x)
 - Asin (float x)
 - Acos (float x)
 - Atan (float x)
 - Sinh (float x)
 - Cosh (float x)
 - Tanh (float x)
 - Asinh (float x)
 - Acosh (float x)
 - Atanh (float x)
 - Negate (float x)
 - GetHashCode (float x)
 - TInt
 - Equals (int x, int y)
 - Compare (int x, int y)
 - Add (int x, int y)
 - Subtract (int x, int y)
 - Multiply (int x, int y)
 - Divide (int x, int y)
 - Abs (int x)
 - Signum (int x)
 - FromInteger (int x)
 - FromDecimal (decimal x)
 - FromFloat (float x)
 - FromDouble (double x)
 - Negate (int x)
 - GetHashCode (int x)
 - True ()
 - False ()
 - And (int a, int b)
 - Or (int a, int b)
 - Not (int a)
 - XOr (int a, int b)
 - Implies (int a, int b)
 - BiCondition (int a, int b)
 - TLong
 - Equals (long x, long y)
 - Compare (long x, long y)
 - Add (long x, long y)
 - Subtract (long x, long y)
 - Multiply (long x, long y)
 - Divide (long x, long y)
 - Abs (long x)
 - Signum (long x)
 - FromInteger (int x)
 - FromDecimal (decimal x)
 - FromFloat (float x)
 - FromDouble (double x)
 - Negate (long x)
 - GetHashCode (long x)
 - True ()
 - False ()
 - And (long a, long b)
 - Or (long a, long b)
 - Not (long a)
 - XOr (long a, long b)
 - Implies (long a, long b)
 - BiCondition (long a, long b)
 - TNumericChar
 - Equals (char x, char y)
 - Compare (char x, char y)
 - GetHashCode (char x)
 - Add (char x, char y)
 - Subtract (char x, char y)
 - Multiply (char x, char y)
 - Negate (char x)
 - Abs (char x)
 - Signum (char x)
 - FromInteger (int x)
 - FromDecimal (decimal x)
 - FromFloat (float x)
 - FromDouble (double x)
 - Divide (char x, char y)
 - TShort
 - Equals (short x, short y)
 - Compare (short x, short y)
 - Add (short x, short y)
 - Subtract (short x, short y)
 - Multiply (short x, short y)
 - Divide (short x, short y)
 - Abs (short x)
 - Signum (short x)
 - FromInteger (int x)
 - FromDecimal (decimal x)
 - FromFloat (float x)
 - FromDouble (double x)
 - Negate (short x)
 - GetHashCode (short x)
 - True ()
 - False ()
 - And (short a, short b)
 - Or (short a, short b)
 - Not (short a)
 - XOr (short a, short b)
 - Implies (short a, short b)
 - BiCondition (short a, short b)
 - TString
 - TStringOrdinalIgnoreCase
 - TStringOrdinal
 - TStringCurrentCultureIgnoreCase
 - TStringCurrentCulture
 
Sub modules
| Eq | 
| Hashable | 
| Monoid | 
| Ord | 
Integer number
Methods
method bool Equals (bigint x, bigint y) Source #
Equality test
Parameters
| param | x | The left hand side of the equality operation  | 
| param | y | The right hand side of the equality operation  | 
| returns | True if x and y are equal  | |
method int Compare (bigint x, bigint y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method bigint Add (bigint x, bigint y) Source #
Find the sum of two numbers
Parameters
| param | x | left hand side of the addition operation  | 
| param | y | right hand side of the addition operation  | 
| returns | The sum of x and y  | |
method bigint Subtract (bigint x, bigint y) Source #
Find the difference between two values
Parameters
| param | x | left hand side of the subtraction operation  | 
| param | y | right hand side of the subtraction operation  | 
| returns | The difference between x and y  | |
method bigint Multiply (bigint x, bigint y) Source #
Find the product of two numbers
Parameters
| param | x | left hand side of the product operation  | 
| param | y | right hand side of the product operation  | 
| returns | The product of x and y  | |
method bigint Divide (bigint x, bigint y) Source #
Divide two numbers
Parameters
| param | x | left hand side of the division operation  | 
| param | y | right hand side of the division operation  | 
| returns | x / y  | |
method bigint Abs (bigint x) Source #
Find the absolute value of a number
Parameters
| param | x | The value to find the absolute value of  | 
| returns | The non-negative absolute value of x  | |
method bigint Signum (bigint x) Source #
Find the sign of x
Parameters
| param | x | The value to find the sign of  | 
| returns | -1, 0, or +1  | |
method bigint FromInteger (int x) Source #
Generate a numeric value from an integer
Parameters
| param | x | The integer to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method bigint FromDecimal (decimal x) Source #
Generate a numeric value from a float
Parameters
| param | x | The float to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method bigint FromFloat (float x) Source #
Generate a numeric value from a double
Parameters
| param | x | The double to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method bigint FromDouble (double x) Source #
Generate a numeric value from a decimal
Parameters
| param | x | The decimal to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method bigint Negate (bigint x) Source #
Negate the value
Parameters
| param | x | Value to negate  | 
| returns | The negated source value  | |
method bigint Append (bigint x, bigint y) Source #
Semigroup append (sum)
Parameters
| param | x | left hand side of the append operation  | 
| param | y | right hand side of the append operation  | 
| returns | x + y  | |
method int GetHashCode (bigint x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
method bigint And (bigint a, bigint b) Source #
Returns the result of the bitwise AND operation between a and b
Parameters
| returns | The result of the bitwise AND operation between   | |
method bigint Or (bigint a, bigint b) Source #
Returns the result of the bitwise OR operation between a and b
Parameters
| returns | The result of the bitwise OR operation between   | |
method bigint Not (bigint a) Source #
Returns the result of the bitwise NOT operation on a
Parameters
| returns | The result of the bitwise NOT operation on   | |
method bigint XOr (bigint a, bigint b) Source #
Returns the result of the bitwise exclusive-OR operation between a and b
Parameters
| returns | The result of the bitwise exclusive-OR operation between   | |
method bigint Implies (bigint a, bigint b) Source #
Logical implication
Parameters
| returns | If   | |
method bigint BiCondition (bigint a, bigint b) Source #
Bitwise bi-conditional.
Parameters
| returns | 
  | |
Bool class instance. Implements
Eq〈bool〉
Ord〈bool〉
Bool〈bool〉
Methods
method bool And (bool a, bool b) Source #
Returns the result of the logical AND operation between a and b
Parameters
| returns | The result of the logical AND operation between   | |
method int Compare (bool x, bool y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method bool Equals (bool x, bool y) Source #
Equality test
Parameters
| param | x | The left hand side of the equality operation  | 
| param | y | The right hand side of the equality operation  | 
| returns | True if x and y are equal  | |
method int GetHashCode (bool x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
method bool Not (bool a) Source #
Returns the result of the logical NOT operation on a
Parameters
| returns | The result of the logical NOT operation on   | |
method bool Or (bool a, bool b) Source #
Returns the result of the logical OR operation between a and b
Parameters
| returns | The result of the logical OR operation between   | |
method bool XOr (bool a, bool b) Source #
Returns the result of the logical exclusive-OR operation between a and b
Parameters
| returns | The result of the logical exclusive-OR operation between   | |
method bool Implies (bool a, bool b) Source #
Logical implication
Parameters
| returns | If   | |
method bool BiCondition (bool a, bool b) Source #
Logical bi-conditional.  Both a and b must be true, or both a and b must
be false.
Parameters
| returns | 
  | |
TBoolBool class instance. Implements
Eq〈(bool, bool)〉
Ord〈(bool, bool)〉
Bool〈(bool, bool)〉
Methods
method (bool, bool) And ((bool, bool) a, (bool, bool) b) Source #
Returns the result of the logical AND operation between a and b
Parameters
| returns | The result of the logical AND operation between   | |
method int Compare ((bool, bool) x, (bool, bool) y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method bool Equals ((bool, bool) x, (bool, bool) y) Source #
Equality test
Parameters
| param | x | The left hand side of the equality operation  | 
| param | y | The right hand side of the equality operation  | 
| returns | True if x and y are equal  | |
method int GetHashCode ((bool, bool) x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
method (bool, bool) Not ((bool, bool) a) Source #
Returns the result of the logical NOT operation on a
Parameters
| returns | The result of the logical NOT operation on   | |
method (bool, bool) Or ((bool, bool) a, (bool, bool) b) Source #
Returns the result of the logical OR operation between a and b
Parameters
| returns | The result of the logical OR operation between   | |
method (bool, bool) XOr ((bool, bool) a, (bool, bool) b) Source #
Returns the result of the logical exclusive-OR operation between a and b
Parameters
| returns | The result of the logical exclusive-OR operation between   | |
method (bool, bool) Implies ((bool, bool) a, (bool, bool) b) Source #
Logical implication
Parameters
| returns | If   | |
method (bool, bool) BiCondition ((bool, bool) a, (bool, bool) b) Source #
Logical bi-conditional.  Both a and b must be true, or both a and b must
be false.
Parameters
| returns | 
  | |
Integer number
Methods
method bool Equals (char x, char y) Source #
Equality test
Parameters
| param | x | The left hand side of the equality operation  | 
| param | y | The right hand side of the equality operation  | 
| returns | True if x and y are equal  | |
method int Compare (char x, char y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method int GetHashCode (char x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
Methods
method bool Equals (decimal x, decimal y) Source #
Equality test
Parameters
| param | x | Left hand side of the equality operation  | 
| param | y | Right hand side of the equality operation  | 
| returns | True if parameters are equal  | |
method int Compare (decimal x, decimal y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method decimal Add (decimal x, decimal y) Source #
Find the sum of two values
Parameters
| param | x | left hand side of the addition operation  | 
| param | y | right hand side of the addition operation  | 
| returns | The sum of x and y  | |
method decimal Subtract (decimal x, decimal y) Source #
Find the difference between two values
Parameters
| param | x | left hand side of the subtraction operation  | 
| param | y | right hand side of the subtraction operation  | 
| returns | The difference between x and y  | |
method decimal Multiply (decimal x, decimal y) Source #
Find the product of two values
Parameters
| param | x | left hand side of the product operation  | 
| param | y | right hand side of the product operation  | 
| returns | The product of x and y  | |
method decimal Divide (decimal x, decimal y) Source #
Divide two numbers
Parameters
| param | x | left hand side of the division operation  | 
| param | y | right hand side of the division operation  | 
| returns | x / y  | |
method decimal Abs (decimal x) Source #
Find the absolute value of a number
Parameters
| param | x | The value to find the absolute value of  | 
| returns | The non-negative absolute value of x  | |
method decimal Signum (decimal x) Source #
Find the sign of x
Parameters
| param | x | The value to find the sign of  | 
| returns | -1, 0, or +1  | |
method decimal FromInteger (int x) Source #
Generate a numeric value from an integer
Parameters
| param | x | The integer to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method decimal FromDecimal (decimal x) Source #
Generate a numeric value from a decimal
Parameters
| param | x | The decimal to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method decimal FromFloat (float x) Source #
Generate a numeric value from a float
Parameters
| param | x | The float to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method decimal FromDouble (double x) Source #
Generate a numeric value from a double
Parameters
| param | x | The double to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method decimal FromRational (Ratio<int> x) Source #
Generates a fractional value from an integer ratio.
Parameters
| param | x | The ratio to convert  | 
| returns | The equivalent of x in the implementing type.  | |
Returns an approximation of pi.
Parameters
| returns | A reasonable approximation of pi in this type  | |
method decimal Exp (decimal x) Source #
The exponential function.
Parameters
| param | x | The value for which we are calculating the exponential  | 
| returns | ||
method decimal Sqrt (decimal x) Source #
Calculates the square root of a value.
Parameters
| param | x | The value for which we are calculating the square root.  | 
| returns | .  | |
method decimal Log (decimal x) Source #
Calculates the natural logarithm of a value.
Parameters
| param | x | The value for which we are calculating the natural logarithm.  | 
| returns | .  | |
method decimal Pow (decimal x, decimal y) Source #
Raises x to the power y
Parameters
| param | x | The base to be raised to y  | 
| param | y | The exponent to which we are raising x  | 
| returns | .  | |
method decimal LogBase (decimal b, decimal x) Source #
Calculates the logarithm of a value with respect to an arbitrary base.
Parameters
| param | x | The base to use for the logarithm of t  | 
| param | y | The value for which we are calculating the logarithm.  | 
| returns | .  | |
method decimal Sin (decimal x) Source #
Calculates the sine of an angle.
Parameters
| param | x | An angle, in radians  | 
| returns | ||
method decimal Cos (decimal x) Source #
Calculates the cosine of an angle.
Parameters
| param | x | An angle, in radians  | 
| returns | ||
method decimal Tan (decimal x) Source #
Calculates the tangent of an angle.
Parameters
| param | x | An angle, in radians  | 
| returns | ||
method decimal Asin (decimal x) Source #
Calculates an arcsine.
Parameters
| param | x | The value for which an arcsine is to be calculated.  | 
| returns | , in radians.  | |
method decimal Acos (decimal x) Source #
Calculates an arc-cosine.
Parameters
| param | x | The value for which an arc-cosine is to be calculated  | 
| returns | , in radians  | |
method decimal Atan (decimal x) Source #
Calculates an arc-tangent.
Parameters
| param | x | The value for which an arc-tangent is to be calculated  | 
| returns | , in radians  | |
method decimal Sinh (decimal x) Source #
Calculates a hyperbolic sine.
Parameters
| param | x | The value for which a hyperbolic sine is to be calculated  | 
| returns | ||
method decimal Cosh (decimal x) Source #
Calculates a hyperbolic cosine.
Parameters
| param | x | The value for which a hyperbolic cosine is to be calculated  | 
| returns | ||
method decimal Tanh (decimal x) Source #
Calculates a hyperbolic tangent.
Parameters
| param | x | The value for which a hyperbolic tangent is to be calculated.  | 
| returns | ||
method decimal Asinh (decimal x) Source #
Calculates an area hyperbolic sine
Parameters
| param | x | The value for which an area hyperbolic sine is to be calculated.  | 
| returns | .  | |
method decimal Acosh (decimal x) Source #
Calculates an area hyperbolic cosine.
Parameters
| param | x | The value for which an area hyperbolic cosine is to be calculated.  | 
| returns | .  | |
method decimal Atanh (decimal x) Source #
Calculates an area hyperbolic tangent.
Parameters
| param | x | The value for which an area hyperbolic tangent is to be calculated.  | 
| returns | ||
method decimal Negate (decimal x) Source #
Negate the value
Parameters
| param | x | Value to negate  | 
| returns | The negated source value  | |
method int GetHashCode (decimal x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
Methods
method bool Equals (double x, double y) Source #
Equality test
Parameters
| param | x | Left hand side of the equality operation  | 
| param | y | Right hand side of the equality operation  | 
| returns | True if parameters are equal  | |
method int Compare (double x, double y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method double Add (double x, double y) Source #
Find the sum of two values
Parameters
| param | x | left hand side of the addition operation  | 
| param | y | right hand side of the addition operation  | 
| returns | The sum of x and y  | |
method double Subtract (double x, double y) Source #
Find the difference between two values
Parameters
| param | x | left hand side of the subtraction operation  | 
| param | y | right hand side of the subtraction operation  | 
| returns | The difference between x and y  | |
method double Multiply (double x, double y) Source #
Find the product of two values
Parameters
| param | x | left hand side of the product operation  | 
| param | y | right hand side of the product operation  | 
| returns | The product of x and y  | |
method double Divide (double x, double y) Source #
Divide two numbers
Parameters
| param | x | left hand side of the division operation  | 
| param | y | right hand side of the division operation  | 
| returns | x / y  | |
method double Abs (double x) Source #
Find the absolute value of a number
Parameters
| param | x | The value to find the absolute value of  | 
| returns | The non-negative absolute value of x  | |
method double Signum (double x) Source #
Find the sign of x
Parameters
| param | x | The value to find the sign of  | 
| returns | -1, 0, or +1  | |
method double FromInteger (int x) Source #
Generate a numeric value from an integer
Parameters
| param | x | The integer to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method double FromDecimal (decimal x) Source #
Generate a numeric value from a decimal
Parameters
| param | x | The decimal to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method double FromFloat (float x) Source #
Generate a numeric value from a float
Parameters
| param | x | The float to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method double FromDouble (double x) Source #
Generate a numeric value from a double
Parameters
| param | x | The double to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method double FromRational (Ratio<int> x) Source #
Generates a fractional value from an integer ratio.
Parameters
| param | x | The ratio to convert  | 
| returns | The equivalent of x in the implementing type.  | |
Returns an approximation of pi.
Parameters
| returns | A reasonable approximation of pi in this type  | |
method double Exp (double x) Source #
The exponential function.
Parameters
| param | x | The value for which we are calculating the exponential  | 
| returns | ||
method double Sqrt (double x) Source #
Calculates the square root of a value.
Parameters
| param | x | The value for which we are calculating the square root.  | 
| returns | .  | |
method double Log (double x) Source #
Calculates the natural logarithm of a value.
Parameters
| param | x | The value for which we are calculating the natural logarithm.  | 
| returns | .  | |
method double Pow (double x, double y) Source #
Raises x to the power y
Parameters
| param | x | The base to be raised to y  | 
| param | y | The exponent to which we are raising x  | 
| returns | .  | |
method double LogBase (double b, double x) Source #
Calculates the logarithm of a value with respect to an arbitrary base.
Parameters
| param | x | The base to use for the logarithm of t  | 
| param | y | The value for which we are calculating the logarithm.  | 
| returns | .  | |
method double Sin (double x) Source #
Calculates the sine of an angle.
Parameters
| param | x | An angle, in radians  | 
| returns | ||
method double Cos (double x) Source #
Calculates the cosine of an angle.
Parameters
| param | x | An angle, in radians  | 
| returns | ||
method double Tan (double x) Source #
Calculates the tangent of an angle.
Parameters
| param | x | An angle, in radians  | 
| returns | ||
method double Asin (double x) Source #
Calculates an arcsine.
Parameters
| param | x | The value for which an arcsine is to be calculated.  | 
| returns | , in radians.  | |
method double Acos (double x) Source #
Calculates an arc-cosine.
Parameters
| param | x | The value for which an arc-cosine is to be calculated  | 
| returns | , in radians  | |
method double Atan (double x) Source #
Calculates an arc-tangent.
Parameters
| param | x | The value for which an arc-tangent is to be calculated  | 
| returns | , in radians  | |
method double Sinh (double x) Source #
Calculates a hyperbolic sine.
Parameters
| param | x | The value for which a hyperbolic sine is to be calculated  | 
| returns | ||
method double Cosh (double x) Source #
Calculates a hyperbolic cosine.
Parameters
| param | x | The value for which a hyperbolic cosine is to be calculated  | 
| returns | ||
method double Tanh (double x) Source #
Calculates a hyperbolic tangent.
Parameters
| param | x | The value for which a hyperbolic tangent is to be calculated.  | 
| returns | ||
method double Asinh (double x) Source #
Calculates an area hyperbolic sine
Parameters
| param | x | The value for which an area hyperbolic sine is to be calculated.  | 
| returns | .  | |
method double Acosh (double x) Source #
Calculates an area hyperbolic cosine.
Parameters
| param | x | The value for which an area hyperbolic cosine is to be calculated.  | 
| returns | .  | |
method double Atanh (double x) Source #
Calculates an area hyperbolic tangent.
Parameters
| param | x | The value for which an area hyperbolic tangent is to be calculated.  | 
| returns | ||
method double Negate (double x) Source #
Negate the value
Parameters
| param | x | Value to negate  | 
| returns | The negated source value  | |
method int GetHashCode (double x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
Methods
method bool Equals (float x, float y) Source #
Equality test
Parameters
| param | x | Left hand side of the equality operation  | 
| param | y | Right hand side of the equality operation  | 
| returns | True if parameters are equal  | |
method int Compare (float x, float y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method float Add (float x, float y) Source #
Find the sum of two values
Parameters
| param | x | left hand side of the addition operation  | 
| param | y | right hand side of the addition operation  | 
| returns | The sum of x and y  | |
method float Subtract (float x, float y) Source #
Find the difference between two values
Parameters
| param | x | left hand side of the subtraction operation  | 
| param | y | right hand side of the subtraction operation  | 
| returns | The difference between x and y  | |
method float Multiply (float x, float y) Source #
Find the product of two values
Parameters
| param | x | left hand side of the product operation  | 
| param | y | right hand side of the product operation  | 
| returns | The product of x and y  | |
method float Divide (float x, float y) Source #
Divide two numbers
Parameters
| param | x | left hand side of the division operation  | 
| param | y | right hand side of the division operation  | 
| returns | x / y  | |
method float Abs (float x) Source #
Find the absolute value of a number
Parameters
| param | x | The value to find the absolute value of  | 
| returns | The non-negative absolute value of x  | |
method float Signum (float x) Source #
Find the sign of x
Parameters
| param | x | The value to find the sign of  | 
| returns | -1, 0, or +1  | |
method float FromInteger (int x) Source #
Generate a numeric value from an integer
Parameters
| param | x | The integer to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method float FromDecimal (decimal x) Source #
Generate a numeric value from a decimal
Parameters
| param | x | The decimal to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method float FromFloat (float x) Source #
Generate a numeric value from a float
Parameters
| param | x | The float to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method float FromDouble (double x) Source #
Generate a numeric value from a double
Parameters
| param | x | The double to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method float FromRational (Ratio<int> x) Source #
Generates a fractional value from an integer ratio.
Parameters
| param | x | The ratio to convert  | 
| returns | The equivalent of x in the implementing type.  | |
Returns an approximation of pi.
Parameters
| returns | A reasonable approximation of pi in this type  | |
method float Exp (float x) Source #
The exponential function.
Parameters
| param | x | The value for which we are calculating the exponential  | 
| returns | ||
method float Sqrt (float x) Source #
Calculates the square root of a value.
Parameters
| param | x | The value for which we are calculating the square root.  | 
| returns | .  | |
method float Log (float x) Source #
Calculates the natural logarithm of a value.
Parameters
| param | x | The value for which we are calculating the natural logarithm.  | 
| returns | .  | |
method float Pow (float x, float y) Source #
Raises x to the power y
Parameters
| param | x | The base to be raised to y  | 
| param | y | The exponent to which we are raising x  | 
| returns | .  | |
method float LogBase (float b, float x) Source #
Calculates the logarithm of a value with respect to an arbitrary base.
Parameters
| param | x | The base to use for the logarithm of t  | 
| param | y | The value for which we are calculating the logarithm.  | 
| returns | .  | |
method float Sin (float x) Source #
Calculates the sine of an angle.
Parameters
| param | x | An angle, in radians  | 
| returns | ||
method float Cos (float x) Source #
Calculates the cosine of an angle.
Parameters
| param | x | An angle, in radians  | 
| returns | ||
method float Tan (float x) Source #
Calculates the tangent of an angle.
Parameters
| param | x | An angle, in radians  | 
| returns | ||
method float Asin (float x) Source #
Calculates an arcsine.
Parameters
| param | x | The value for which an arcsine is to be calculated.  | 
| returns | , in radians.  | |
method float Acos (float x) Source #
Calculates an arc-cosine.
Parameters
| param | x | The value for which an arc-cosine is to be calculated  | 
| returns | , in radians  | |
method float Atan (float x) Source #
Calculates an arc-tangent.
Parameters
| param | x | The value for which an arc-tangent is to be calculated  | 
| returns | , in radians  | |
method float Sinh (float x) Source #
Calculates a hyperbolic sine.
Parameters
| param | x | The value for which a hyperbolic sine is to be calculated  | 
| returns | ||
method float Cosh (float x) Source #
Calculates a hyperbolic cosine.
Parameters
| param | x | The value for which a hyperbolic cosine is to be calculated  | 
| returns | ||
method float Tanh (float x) Source #
Calculates a hyperbolic tangent.
Parameters
| param | x | The value for which a hyperbolic tangent is to be calculated.  | 
| returns | ||
method float Asinh (float x) Source #
Calculates an area hyperbolic sine
Parameters
| param | x | The value for which an area hyperbolic sine is to be calculated.  | 
| returns | .  | |
method float Acosh (float x) Source #
Calculates an area hyperbolic cosine.
Parameters
| param | x | The value for which an area hyperbolic cosine is to be calculated.  | 
| returns | .  | |
method float Atanh (float x) Source #
Calculates an area hyperbolic tangent.
Parameters
| param | x | The value for which an area hyperbolic tangent is to be calculated.  | 
| returns | ||
method float Negate (float x) Source #
Negate the value
Parameters
| param | x | Value to negate  | 
| returns | The negated source value  | |
method int GetHashCode (float x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
Integer number
Methods
method bool Equals (int x, int y) Source #
Equality test
Parameters
| param | x | The left hand side of the equality operation  | 
| param | y | The right hand side of the equality operation  | 
| returns | True if x and y are equal  | |
method int Compare (int x, int y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method int Add (int x, int y) Source #
Find the sum of two numbers
Parameters
| param | x | left hand side of the addition operation  | 
| param | y | right hand side of the addition operation  | 
| returns | The sum of x and y  | |
method int Subtract (int x, int y) Source #
Find the difference between two values
Parameters
| param | x | left hand side of the subtraction operation  | 
| param | y | right hand side of the subtraction operation  | 
| returns | The difference between x and y  | |
method int Multiply (int x, int y) Source #
Find the product of two numbers
Parameters
| param | x | left hand side of the product operation  | 
| param | y | right hand side of the product operation  | 
| returns | The product of x and y  | |
method int Divide (int x, int y) Source #
Divide two numbers
Parameters
| param | x | left hand side of the division operation  | 
| param | y | right hand side of the division operation  | 
| returns | x / y  | |
method int Abs (int x) Source #
Find the absolute value of a number
Parameters
| param | x | The value to find the absolute value of  | 
| returns | The non-negative absolute value of x  | |
method int Signum (int x) Source #
Find the sign of x
Parameters
| param | x | The value to find the sign of  | 
| returns | -1, 0, or +1  | |
method int FromInteger (int x) Source #
Generate a numeric value from an integer
Parameters
| param | x | The integer to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method int FromDecimal (decimal x) Source #
Generate a numeric value from a float
Parameters
| param | x | The float to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method int FromFloat (float x) Source #
Generate a numeric value from a double
Parameters
| param | x | The double to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method int FromDouble (double x) Source #
Generate a numeric value from a decimal
Parameters
| param | x | The decimal to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method int Negate (int x) Source #
Negate the value
Parameters
| param | x | Value to negate  | 
| returns | The negated source value  | |
method int GetHashCode (int x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
method int And (int a, int b) Source #
Returns the result of the bitwise AND operation between a and b
Parameters
| returns | The result of the bitwise AND operation between   | |
method int Or (int a, int b) Source #
Returns the result of the bitwise OR operation between a and b
Parameters
| returns | The result of the bitwise OR operation between   | |
method int Not (int a) Source #
Returns the result of the bitwise NOT operation on a
Parameters
| returns | The result of the bitwise NOT operation on   | |
method int XOr (int a, int b) Source #
Returns the result of the bitwise exclusive-OR operation between a and b
Parameters
| returns | The result of the bitwise exclusive-OR operation between   | |
method int Implies (int a, int b) Source #
Logical implication
Parameters
| returns | If   | |
method int BiCondition (int a, int b) Source #
Bitwise bi-conditional.
Parameters
| returns | 
  | |
Long integer number
Methods
method bool Equals (long x, long y) Source #
Equality test
Parameters
| param | x | The left hand side of the equality operation  | 
| param | y | The right hand side of the equality operation  | 
| returns | True if x and y are equal  | |
method int Compare (long x, long y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method long Add (long x, long y) Source #
Find the sum of two numbers
Parameters
| param | x | left hand side of the addition operation  | 
| param | y | right hand side of the addition operation  | 
| returns | The sum of x and y  | |
method long Subtract (long x, long y) Source #
Find the difference between two values
Parameters
| param | x | left hand side of the subtraction operation  | 
| param | y | right hand side of the subtraction operation  | 
| returns | The difference between x and y  | |
method long Multiply (long x, long y) Source #
Fund the product of two numbers
Parameters
| param | x | left hand side of the product operation  | 
| param | y | right hand side of the product operation  | 
| returns | The product of x and y  | |
method long Divide (long x, long y) Source #
Divide x by y
Parameters
| param | x | left hand side of the division operation  | 
| param | y | right hand side of the division operation  | 
| returns | x / y  | |
method long Abs (long x) Source #
Find the absolute value of a number
Parameters
| param | x | The value to find the absolute value of  | 
| returns | The non-negative absolute value of x  | |
method long Signum (long x) Source #
Find the sign of x
Parameters
| param | x | The value to find the sign of  | 
| returns | -1, 0, or +1  | |
method long FromInteger (int x) Source #
Generate a numeric value from an integer
Parameters
| param | x | The integer to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method long FromDecimal (decimal x) Source #
Generate a numeric value from a float
Parameters
| param | x | The float to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method long FromFloat (float x) Source #
Generate a numeric value from a double
Parameters
| param | x | The double to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method long FromDouble (double x) Source #
Generate a numeric value from a decimal
Parameters
| param | x | The decimal to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method long Negate (long x) Source #
Negate the value
Parameters
| param | x | Value to negate  | 
| returns | The negated source value  | |
method int GetHashCode (long x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
method long And (long a, long b) Source #
Returns the result of the bitwise AND operation between a and b
Parameters
| returns | The result of the bitwise AND operation between   | |
method long Or (long a, long b) Source #
Returns the result of the bitwise OR operation between a and b
Parameters
| returns | The result of the bitwise OR operation between   | |
method long Not (long a) Source #
Returns the result of the bitwise NOT operation on a
Parameters
| returns | The result of the bitwise NOT operation on   | |
method long XOr (long a, long b) Source #
Returns the result of the bitwise exclusive-OR operation between a and b
Parameters
| returns | The result of the bitwise exclusive-OR operation between   | |
method long Implies (long a, long b) Source #
Logical implication
Parameters
| returns | If   | |
method long BiCondition (long a, long b) Source #
Bitwise bi-conditional.
Parameters
| returns | 
  | |
struct TNumericChar Source #
Integer number
Methods
method bool Equals (char x, char y) Source #
Equality test
Parameters
| param | x | The left hand side of the equality operation  | 
| param | y | The right hand side of the equality operation  | 
| returns | True if x and y are equal  | |
method int Compare (char x, char y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method int GetHashCode (char x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
method char FromInteger (int x) Source #
method char FromDecimal (decimal x) Source #
method char FromDouble (double x) Source #
Short integer number
Methods
method bool Equals (short x, short y) Source #
Equality test
Parameters
| param | x | The left hand side of the equality operation  | 
| param | y | The right hand side of the equality operation  | 
| returns | True if x and y are equal  | |
method int Compare (short x, short y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method short Add (short x, short y) Source #
Find the sum of two numbers
Parameters
| param | x | left hand side of the addition operation  | 
| param | y | right hand side of the addition operation  | 
| returns | The sum of x and y  | |
method short Subtract (short x, short y) Source #
Find the difference between two values
Parameters
| param | x | left hand side of the subtraction operation  | 
| param | y | right hand side of the subtraction operation  | 
| returns | The difference between x and y  | |
method short Multiply (short x, short y) Source #
Fund the product of two numbers
Parameters
| param | x | left hand side of the product operation  | 
| param | y | right hand side of the product operation  | 
| returns | The product of x and y  | |
method short Divide (short x, short y) Source #
Divide x by y
Parameters
| param | x | left hand side of the division operation  | 
| param | y | right hand side of the division operation  | 
| returns | x / y  | |
method short Abs (short x) Source #
Find the absolute value of a number
Parameters
| param | x | The value to find the absolute value of  | 
| returns | The non-negative absolute value of x  | |
method short Signum (short x) Source #
Find the sign of x
Parameters
| param | x | The value to find the sign of  | 
| returns | -1, 0, or +1  | |
method short FromInteger (int x) Source #
Generate a numeric value from an integer
Parameters
| param | x | The integer to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method short FromDecimal (decimal x) Source #
Generate a numeric value from a float
Parameters
| param | x | The float to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method short FromFloat (float x) Source #
Generate a numeric value from a double
Parameters
| param | x | The double to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method short FromDouble (double x) Source #
Generate a numeric value from a decimal
Parameters
| param | x | The decimal to use  | 
| returns | The equivalent of x in the Num〈A〉  | |
method short Negate (short x) Source #
Negate the value
Parameters
| param | x | Value to negate  | 
| returns | The negated source value  | |
method int GetHashCode (short x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
method short And (short a, short b) Source #
Returns the result of the bitwise AND operation between a and b
Parameters
| returns | The result of the bitwise AND operation between   | |
method short Or (short a, short b) Source #
Returns the result of the bitwise OR operation between a and b
Parameters
| returns | The result of the bitwise OR operation between   | |
method short Not (short a) Source #
Returns the result of the bitwise NOT operation on a
Parameters
| returns | The result of the bitwise NOT operation on   | |
method short XOr (short a, short b) Source #
Returns the result of the bitwise exclusive-OR operation between a and b
Parameters
| returns | The result of the bitwise exclusive-OR operation between   | |
method short Implies (short a, short b) Source #
Logical implication
Parameters
| returns | If   | |
method short BiCondition (short a, short b) Source #
Bitwise bi-conditional.
Parameters
| returns | 
  | |
Methods
method bool Equals (string x, string y) Source #
Equality test
Parameters
| param | x | The left hand side of the equality operation  | 
| param | y | The right hand side of the equality operation  | 
| returns | True if x and y are equal  | |
method int Compare (string x, string y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method int GetHashCode (string x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
struct TStringOrdinalIgnoreCase Source #
Methods
method bool Equals (string x, string y) Source #
Equality test
Parameters
| param | x | The left hand side of the equality operation  | 
| param | y | The right hand side of the equality operation  | 
| returns | True if x and y are equal  | |
method int Compare (string x, string y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method int GetHashCode (string x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
struct TStringOrdinal Source #
Methods
method bool Equals (string x, string y) Source #
Equality test
Parameters
| param | x | The left hand side of the equality operation  | 
| param | y | The right hand side of the equality operation  | 
| returns | True if x and y are equal  | |
method int Compare (string x, string y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method int GetHashCode (string x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
struct TStringCurrentCultureIgnoreCase Source #
Methods
method bool Equals (string x, string y) Source #
Equality test
Parameters
| param | x | The left hand side of the equality operation  | 
| param | y | The right hand side of the equality operation  | 
| returns | True if x and y are equal  | |
method int Compare (string x, string y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method int GetHashCode (string x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |
struct TStringCurrentCulture Source #
Methods
method bool Equals (string x, string y) Source #
Equality test
Parameters
| param | x | The left hand side of the equality operation  | 
| param | y | The right hand side of the equality operation  | 
| returns | True if x and y are equal  | |
method int Compare (string x, string y) Source #
Compare two values
Parameters
| param | x | Left hand side of the compare operation  | 
| param | y | Right hand side of the compare operation  | 
| returns | if x greater than y : 1 if x less than y : -1 if x equals y : 0  | |
method int GetHashCode (string x) Source #
Get the hash-code of the provided value
Parameters
| returns | Hash code of x  | |