VectorF Class

VectorF Class

Defines an n-dimensional vector (single-precision).

Inheritance Hierarchy

SystemObject
DigitalRune.Mathematics.AlgebraVectorF

Namespace: DigitalRune.Mathematics.Algebra
Assembly: DigitalRune.Mathematics (in DigitalRune.Mathematics.dll) Version: 1.14.0.0 (1.14.0.14427)

Syntax

C++

Copy

[SerializableAttribute]
[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public class VectorF : IEquatable<VectorF>, 
	ISerializable, IXmlSerializable

<SerializableAttribute>
<TypeConverterAttribute(GetType(ExpandableObjectConverter))>
Public Class VectorF
	Implements IEquatable(Of VectorF), ISerializable, 
	IXmlSerializable

[SerializableAttribute]
[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public ref class VectorF : IEquatable<VectorF^>, 
	ISerializable, IXmlSerializable

[<SerializableAttribute>]
[<TypeConverterAttribute(typeof(ExpandableObjectConverter))>]
type VectorF =  
    class
        interface IEquatable<VectorF>
        interface ISerializable
        interface IXmlSerializable
    end

The VectorF type exposes the following members.

Constructors

	Name	Description
	VectorF	Initializes a new instance of the VectorF class with 4 vector elements.
	VectorF(IListSingle)	Initializes a new instance of the VectorF class.
	VectorF(Int32)	Initializes a new instance of the VectorF class.
	VectorF(Single)	Initializes a new instance of the VectorF class.
	VectorF(Int32, Single)	Initializes a new instance of the VectorF class.
	VectorF(SerializationInfo, StreamingContext)	Initializes a new instance of the VectorF class with serialized data.

Top

Methods

	Name	Description
	Absolute	Sets each vector element to its absolute value.
	Absolute(VectorF)	Returns a vector with the absolute values of the elements of the given vector.
	Add	Adds two vectors.
	AreNumericallyEqual(VectorF, VectorF)	Determines whether two vectors are equal (regarding the tolerance EpsilonF).
	AreNumericallyEqual(VectorF, VectorF, Single)	Determines whether two vectors are equal (regarding a specific tolerance).
	Clamp(Single, Single)	Clamps the vector elements to the range [min, max].
	Clamp(VectorF, Single, Single)	Returns a vector with the vector elements clamped to the range [min, max].
	ClampToZero	Clamps near-zero vector elements to zero.
	ClampToZero(Single)	Clamps near-zero vector elements to zero.
	ClampToZero(VectorF)	Returns a vector with near-zero vector elements clamped to 0.
	ClampToZero(VectorF, Single)	Returns a vector with near-zero vector elements clamped to 0.
	Clone	Clones this instance.
	Divide(VectorF, VectorF)	Divides the elements of a vector by the elements of another vector.
	Divide(VectorF, Single)	Divides a vector by a scalar.
	Dot	Returns the dot product of two vectors.
	Equals(Object)	Indicates whether this instance and a specified object are equal. (Overrides ObjectEquals(Object).)
	Equals(VectorF)	Indicates whether the current object is equal to another object of the same type.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Overrides ObjectGetHashCode.)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object.
	GetSchema	This property is reserved, apply the XmlSchemaProviderAttribute to the class instead.
	GetSubvector	Gets a subvector of this vector.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Max	Returns a vector that contains the highest value from each matching pair of components.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Min	Returns a vector that contains the lowest value from each matching pair of elements.
	Multiply(Single, VectorF)	Multiplies a vector by a scalar.
	Multiply(VectorF, VectorF)	Multiplies the components of two vectors by each other.
	Negate	Negates a vector.
	Normalize	Normalizes the vector.
	ProjectTo(VectorF)	Sets this vector to its projection onto the axis given by the target vector.
	ProjectTo(VectorF, VectorF)	Projects a vector onto an axis given by the target vector.
	ReadXml	Generates an object from its XML representation.
	Set(IListSingle)	Sets the vector elements to the values of the list.
	Set(Single)	Sets all vector elements to the specified value.
	Set(Single)	Sets the vector elements to the values of the array.
	Set(VectorF)	Sets this instance to a copy of the specified vector.
	SetSubvector	Sets a subvector of this instance.
	Subtract	Subtracts a vector from a vector.
	ToArray	Converts this vector to an array of float values.
	ToList	Converts this vector to a list of float values.
	ToMatrixF	Converts this VectorF to MatrixF.
	ToString	Returns the string representation of this vector. (Overrides ObjectToString.)
	ToString(IFormatProvider)	Returns the string representation of this vector using the specified culture-specific format information.
	ToVector2F	Converts this VectorF to Vector2F.
	ToVector3F	Converts this VectorF to Vector3F.
	ToVector4F	Converts this VectorF to Vector4F.
	ToVectorD	Converts this VectorF to VectorD.
	TryNormalize	Tries to normalize the vector.
	WriteXml	Converts an object into its XML representation.

Top

Operators

	Name	Description
	Addition	Adds two vectors.
	Division(VectorF, VectorF)	Divides the elements of a vector by the elements of another vector.
	Division(VectorF, Single)	Divides a vector by a scalar.
	Equality	Tests if two vectors are equal.
	(VectorF to Single)	Converts a vector to an array of float values.
	(VectorF to ListSingle)	Converts a vector to a list of float values.
	(VectorF to Vector2F)	Performs an explicit conversion from VectorF to Vector2F.
	(VectorF to Vector3F)	Performs an explicit conversion from VectorF to Vector3F.
	(VectorF to Vector4F)	Performs an explicit conversion from VectorF to Vector4F.
	(VectorF to MatrixF)	Performs an explicit conversion from VectorF to MatrixF.
	GreaterThan	Tests if each element of a vector is greater than the corresponding element of another vector.
	GreaterThanOrEqual	Tests if each element of a vector is greater or equal than the corresponding element of another vector.
	(VectorF to VectorD)	Performs an implicit conversion from VectorF to VectorD.
	Inequality	Tests if two vectors are not equal.
	LessThan	Tests if each element of a vector is less than the corresponding element of another vector.
	LessThanOrEqual	Tests if each element of a vector is less or equal than the corresponding element of another vector.
	Multiply(Single, VectorF)	Multiplies a vector by a scalar.
	Multiply(VectorF, VectorF)	Multiplies the components of two vectors by each other.
	Multiply(VectorF, Single)	Multiplies a vector by a scalar.
	Subtraction	Subtracts a vector from a vector.
	UnaryNegation	Negates a vector.

Top

Properties

	Name	Description
	IndexOfLargestElement	Gets the index (zero-based) of the largest element.
	IndexOfSmallestElement	Gets the index (zero-based) of the smallest element.
	InternalArray	Gets or sets the internal array that is used to store the vector values.
	IsNaN	Gets a value indicating whether a component of the vector is NaN.
	IsNumericallyNormalized	Returns a value indicating whether this vector is normalized (the length is numerically equal to 1).
	IsNumericallyZero	Returns a value indicating whether this vector has zero size (the length is numerically equal to 0).
	Item	Gets or sets the component at the specified index.
	LargestElement	Gets the value of the largest element.
	Length	Gets or sets the length of this vector.
	LengthSquared	Returns the squared length of this vector.
	Normalized	Returns the normalized vector.
	NumberOfElements	Gets the number of elements n.
	SmallestElement	Gets the value of the smallest element.

Top

Reference

DigitalRune.Mathematics.Algebra Namespace