Note
TNumber supports operations which can be performed with various combinations of different types
and handles conversions between types whereas a class derived from BaseEntry represents a single numeric type.
SMath Studio Core documentation
TNumber Class
Container for a numeric value derived from BaseEntry.
Definition
Namespace: SMath.Math.Numeric
Assembly: SMath.Math.Numeric (in SMath.Math.Numeric.dll) Version: 1.73.9126.0
Assembly: SMath.Math.Numeric (in SMath.Math.Numeric.dll) Version: 1.73.9126.0
C#
public sealed class TNumberVB
Public NotInheritable Class TNumberC++
public ref class TNumber sealedF#
[<SealedAttribute>]
type TNumber = class end- Inheritance
- Object TNumber
Constructors
| TNumber() | Default constructor. Constructs a TNumber instance which has no value. |
| TNumber(Double) | Constructs TNumber instance containing a TDouble value. |
| TNumber(InfType) | Constructs TNumber instance containing a TInfinity value. |
| TNumber(TComplex) | Constructs TNumber instance containing a TComplex value. |
| TNumber(TFraction) | Constructs TNumber instance containing a TFraction value. |
| TNumber(TInfinity) | Constructs TNumber instance containing a TInfinity value. |
| TNumber(Double, Double) | Constructs TNumber instance containing either a TFraction value or a TDouble value depending on the value of den argument. If den is equal to 1 then TDouble is set, otherwise TFraction is set. |
| TNumber(TDouble, TDouble) | Constructs TNumber instance containing either a TFraction value or a TDouble value depending on the value of den argument. If den is equal to 1 then TDouble is set, otherwise TFraction is set. |
Methods
| Abs | Returns an absolute value of the number. For a complex number see more details in Abs(). If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| ACos | Computes arccosine of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| ACosec | Computes arccosecant of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| ACosH | Computes inverse hyperbolic cosine of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| ACot | Computes arccotangent of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| ACotH | Computes inverse hyperbolic cotangent of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| Ainterp | Performs interpolation by means of Akima spline. X-coordinates are taken from this vector, Y-coordinates are taken from c2 vector, X-coordinate of the point is specified by pnt. | ||||||
| Alg | Computes the cofactor of a square matrix for the specified row and column. Cofactor for row i and column j is defined as minor for that row and column which is multiplied by (-1)^(i + j). | ||||||
| Arg | Returns the argument of the complex number, see Arg(). If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| ASec | Computes arcsecant of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| ASin | Computes arcsine of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| ASinH | Computes inverse hyperbolic sine of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| ATan | Computes arctangent of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| ATan2 | Computes arctangent of the number this / Base. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| ATanH | Computes inverse hyperbolic tangent of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| Augment | Returns a vector or matrix formed by placing arguments left to right. Arguments value are arrays having the same number of rows or they are scalars and row vectors. | ||||||
| Cinterp | Performs interpolation by means of cubic spline. X-coordinates are taken from this vector, Y-coordinates are taken from c2 vector, X-coordinate of the point is specified by pnt. | ||||||
| Col | Returns a submatrix for the specified column of this matrix. | ||||||
| Cols | Returns the number of columns in a matrix. | ||||||
| Cos | Computes cosine of the number. If obj is of type TMatrix or TSystem then action depends on the number of elements.
| ||||||
| CosH | Computes hyperbolic cosine of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| Cot | Computes cotangent of the number. If obj is of type TMatrix or TSystem then action depends on the number of elements.
| ||||||
| CotH | Computes hyperbolic cotangent of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| CSort | Sorts the specified column of the matrix in ascending order. | ||||||
| Determinant |
Computes the determinant of a matrix according to the type of obj.
| ||||||
| Diag | Builds a square matrix with elements of this vector on the main diagonal. | ||||||
| DoubleOrFraction | If the specified Double value is fractional then creates a new TNumber containing TFraction, otherwise creates a new TNumber containing TDouble. | ||||||
| El(Int32) | Returns the specified element of a vector or a system. | ||||||
| El(Int32, Int32) | Returns the specified element of a matrix or a system. | ||||||
| Equals | Determines whether the specified object is equal to the current object. (Overrides Object.Equals(Object)) | ||||||
| Factorial | Computes factorial of this value. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| FFT | Computes the c1-point discrete Fourier transform (DFT) of this TNumber vector using a fast Fourier transform (FFT) algorithm. | ||||||
| GetHashCode | Serves as the default hash function. (Overrides Object.GetHashCode()) | ||||||
| GetType | Gets the Type of the current instance. (Inherited from Object) | ||||||
| Identity | If obj is TDouble having an integer value then builds and returns an identity matrix with dimension equal to the value. | ||||||
| Im | Converts the contained value to complex number(s) and preserves only the imaginary part of the result. | ||||||
| Length | Gets the total number of elements in all dimensions of a matrix. | ||||||
| Linterp | Performs interpolation by means of piecewise linear spline. X-coordinates are taken from this vector, Y-coordinates are taken from c2 vector, X-coordinate of the point is specified by pnt. | ||||||
| Ln | Computes natural logarithm of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| Log | Computes logarithm to base Base of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| Matrix | Builds a zero matrix with N rows and M columns where N == this and M == value. | ||||||
| Max | If the type of obj is TMatrix or TSystem then returns the maximal value among its elements. If the type of obj is scalar then returns the scalar value of this instance. | ||||||
| Min | If the type of obj is TMatrix or TSystem then returns the minimal value among its elements. If the type of obj is scalar then returns the scalar value of this instance. | ||||||
| Minor | Computes the first minor of a square matrix for the specified row and column. First minor is defined as determinant of a smaller square matrix which is cut down from the original matrix by removal of the specified row and column. | ||||||
| Mod | Computes the remainder after dividing this integer value by the specified integer value. | ||||||
| Norm1 | Computes the 1-norm of the matrix. In order to compute the 1-norm, absolute values are summed down each column and after that the biggest answer is taken. | ||||||
| NormE | Computes the Frobenius (Euclidean) norm of the matrix. | ||||||
| NormI | Computes the infinity-norm of the matrix. In order to compute the infinity-norm, absolute values are summed along each row and after that the biggest answer is taken. | ||||||
| Numden | Converts a scalar numeric value to a two-dimensional vector containing numerator and denominator. | ||||||
| pol2xy | Determines the real and imaginary parts of the complex number having Abs() == this and Arg() == value. | ||||||
| PolyRoots | Finds the polynomial roots for this vector contaning polynomial coefficients. The eigenvalue method is used. | ||||||
| Polyroots2 | Finds the polynomial roots for this vector contaning polynomial coefficients. Alternative algorithm supports maximum 5 variables to solve. | ||||||
| Power(TNumber) | Computes exponent with base equal to this and power equal to value. | ||||||
| Power(TNumber, Boolean) | Computes exponent with base equal to this and power equal to value with options. | ||||||
| Random | Generates the next pseudo-random number. Applicable only if the type of obj is TDouble and there are no units of measurement. | ||||||
| Rank |
Computes the rank of a matrix according to the type of obj.
| ||||||
| Re | Converts the contained value to complex number(s) and preserves only the real part of the result. If the type of obj is TMatrix or TSystem then the operation is applied recursively to the elements. | ||||||
| Reverse | Flips the matrix vertically. | ||||||
| Round(TNumber) | Rounds the value to the specified number of fractional digits. | ||||||
| Round(TNumber, TNumber) | Rounds the value to the specified number of fractional digits using the specified rounding convention. | ||||||
| Row | Returns a submatrix for the specified row of this matrix. | ||||||
| Rows | Returns the number of rows in a matrix. | ||||||
| RSort | Sorts the specified row of the matrix in ascending order. | ||||||
| Sign | Computes the sign function for the number. If obj is of type TSystem then applies this method recursively to all elements of the system. For a scalar value, the sign function is defined as follows.
| ||||||
| Sin | Computes sine of the number. If obj is of type TMatrix or TSystem then action depends on the number of elements.
| ||||||
| SinH | Computes hyperbolic sine of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| Sort | Sorts this vector in ascending order. | ||||||
| Stack | Returns a vector or matrix formed by placing arguments top to bottom. Arguments value are arrays having the same number of columns or they are scalars and column vectors. | ||||||
| Submatrix | Extracts a contiguous submatrix from the matrix. | ||||||
| Tan | Computes tangent of the number. If obj is of type TMatrix or TSystem then action depends on the number of elements.
| ||||||
| TanH | Computes hyperbolic tangent of the number. If obj is of type TSystem then applies this method recursively to all elements of the system. | ||||||
| ToInt32 | Converts the numeric value to Int32 by calling first ToDouble() and then ToInt32(Double). | ||||||
| ToString | Returns a string that represents the current object. (Inherited from Object) | ||||||
| Trace | Computes the trace of a square matrix. | ||||||
| Transpose |
Performs matrix transposition according to the type of obj.
| ||||||
| Trunc | Returns the integer part of this value. | ||||||
| VMinor | Extracts the submatrix of a square matrix by removal of the specified row and column. This submatrix is used for computing the related first minor and cofactor. | ||||||
| VMultiplication | Computes the cross product of two vectors in three-dimensional Euclidean space. | ||||||
| xy2pol() | Converts this complex number to polar coordinates. | ||||||
| xy2pol(TNumber) | Converts a complex number with Re == this and Im == value to polar coordinates. |
Operators
| Addition(TNumber, TNumber) | Adds two TNumber objects. |
| Division(TNumber, TNumber) | Divides two TNumber objects. |
| Equality(TNumber, TNumber) | Returns true if the operands are equal. |
| GreaterThan(TNumber, TNumber) | Returns true if left-hand operand is greater than right-hand operand. |
| Implicit(BaseEntry to TNumber) | Provides implicit conversion from BaseEntry to TNumber. |
| Implicit(Double to TNumber) | Provides implicit conversion from Double to TNumber. |
| Inequality(TNumber, TNumber) | Returns true if the operands are not equal. |
| LessThan(TNumber, TNumber) | Returns true if left-hand operand is less than right-hand operand. |
| Multiply(TNumber, TNumber) | Multiplies two TNumber objects. |
| Subtraction(TNumber, TNumber) | Subtracts two TNumber objects. |
Fields
| obj | Numeric value which is wrapped by TNumber. |