Vector.Min Method
Definition
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.7.0
Overload List
| Min<T>(Vector<T>) | Returns the value of the smallest component of a vector. |
| Min<T>(Vector<T>, T) | Returns a vector whose elements are the minimum of the components of a vector and a real number. |
| Min<T>(Vector<T>, Vector<T>) | Returns a vector whose elements are the minimums of the components of two vectors. |
| Min<T>(T, Vector<T>) | Returns a vector whose elements are the minimum of the components of a vector and a real number. |
Min<T>(Vector<T>)
public static T Min<T>(
this Vector<T> vector
)
Parameters
Type Parameters
- T
Return Value
TThe value of the smallest component in vector.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type Vector<T>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).Remarks
Missing-aware vectors skip missing values. If no non-missing values remain, this method throws InvalidOperationException.
Exceptions
| Invalid | vector is empty, or vector is missing-aware and all values are missing. |
Min<T>(Vector<T>, T)
public static Vector<T> Min<T>(
this Vector<T> vector,
T value
)
Parameters
Type Parameters
- T
Return Value
Vector<T>A vector whose elements are the smallest of the corresponding element of vector and value.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type Vector<T>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).Remarks
When no vector operand is missing-aware, this method uses ordinary Min(T, T) semantics. When a vector operand is missing-aware, missing vector elements are skipped using vector-owned IsMissing(Int32) classification.
For floating-point zero ties, negative zero is returned when either operand is negative zero.
Exceptions
| Argument | vector is null. |
Min<T>(Vector<T>, Vector<T>)
public static Vector<T> Min<T>(
this Vector<T> left,
Vector<T> right
)
Parameters
Type Parameters
- T
Return Value
Vector<T>A vector whose elements are the smallest of the corresponding elements of left and right.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type Vector<T>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).Remarks
When no vector operand is missing-aware, this method uses ordinary Min(T, T) semantics. When a vector operand is missing-aware, missing vector elements are skipped using vector-owned IsMissing(Int32) classification.
For floating-point zero ties, negative zero is returned when either operand is negative zero.
Exceptions
| Argument | left is null. -or- right is null. |
| Dimension | The length of left is not equal to the length of right. |
Min<T>(T, Vector<T>)
public static Vector<T> Min<T>(
T value,
Vector<T> vector
)
Parameters
Type Parameters
- T
Return Value
Vector<T>A vector whose elements are the smallest of the corresponding element of vector and value.
Remarks
When no vector operand is missing-aware, this method uses ordinary Min(T, T) semantics. When a vector operand is missing-aware, missing vector elements are skipped using vector-owned IsMissing(Int32) classification.
For floating-point zero ties, negative zero is returned when either operand is negative zero.
Exceptions
| Argument | vector is null. |