PointN

References

public struct PointN : IDimensional, IEquatable<PointN>, IComparable<PointN>

Represents a single immutable n-dimensional point.

Constructors

PointN

public PointN(IEnumerable<double> coordinates)

Create a new multi-dimensional point.

Parameters:

coordinates (IEnumerable<double>)

Coordinates.

PointN

public PointN(params double[] coordinates)

Create a new multi-dimensional point.

Parameters:

coordinates (params double[])

Coordinates.

Properties

Description

public string Description { get; }

Gets a description of this object type.

Implements: Description

Dimensionality

public int Dimensionality { get; }

Gets the dimensionality of this object instance.

Implements: Dimensionality

IsInfinite

public bool IsInfinite { get; }

Gets whether this point is infinite. If the coordinates contain even a single Infinity value, the point is considered to be at infinity. This test is fast.

IsLarge

public bool IsLarge { get; }

Gets whether this point contains any coordinates that are considered large enough to be problematic for arithmetical operations. Infinities are not counted as big numbers. This test is fast.

IsNegative

public bool IsNegative { get; }

Gets whether this point contains any negative coordinates. Zero is not counted as a negative number. This test is fast.

IsOrigin

public bool IsOrigin { get; }

Gets whether this point represents the origin. All coordinates must be exactly equal to zero for a point to be considered the origin. This test is fast.

IsPositive

public bool IsPositive { get; }

Gets whether this point contains any positive coordinates. Zero is not counted as a positive number. This test is fast.

IsUnit

public bool IsUnit { get; }

Gets whether this point resides on or near the unit hypersphere. This test is fast.

IsUnset

public bool IsUnset { get; }

Gets whether this point is unset. If the coordinates contain even a single NaN value, the point is considered to be unset. This test is fast.

IsZero

public bool IsZero { get; }

Gets whether this point contains any coordinates that are exactly zero. This test is fast.

Indexers

this[]

public double this[int dimension] { get; }

Gets the component of this point for the given axis.

Parameters:

dimension (int)

Methods

CompareTo

public int CompareTo(PointN other)

Compare two PointNs for sort order.

Parameters:

other (PointN)

CreateInfinite

public static PointN CreateInfinite(int dimensionality, bool positive)

Create a new point of a specific dimensionality at infinity.

Parameters:

dimensionality (int)	Dimensionality of point.
positive (bool)	If true, point will reside at positive infinity.

Returns: Infinity point.

CreateOrigin

public static PointN CreateOrigin(int dimensionality)

Create a new origin point of a specific dimensionality.

Parameters:

dimensionality (int)

Dimensionality of point.

Returns: Origin point.

CreateUnset

public static PointN CreateUnset(int dimensionality)

Create a new unset point of a specific dimensionality.

Parameters:

dimensionality (int)

Dimensionality of point.

Returns: None point.

Distance

public double Distance(PointN other)

Compute the distance between two points.

Parameters:

other (PointN)

Second point.

Returns: Distance.

Equals

public override bool Equals(object obj)

Indicates whether this instance and a specified object are equal.

Parameters:

obj (object)

The object to compare with the current instance.

Returns: true if obj and this instance are the same type and represent the same value; otherwise, false.

Overrides: ValueType.Equals

Equals

public bool Equals(PointN other)

Compare two PointNs for equality.

Parameters:

other (PointN)

GetHashCode

public override int GetHashCode()

Returns the hash code for this instance.

Returns: A 32-bit signed integer that is the hash code for this instance.

Overrides: ValueType.GetHashCode

Quadrance

public double Quadrance(PointN other)

Compute the quadrance between two points.

Parameters:

other (PointN)

Second point.

Returns: Quadrance.

ToArray

public double[] ToArray()

Convert the coordinates to a double array.

ToString

public override string ToString()

Returns the fully qualified type name of this instance.

Overrides: ValueType.ToString

Operators

Operation			Result	Description
PointN	+	PointN	PointN	Add two multi-dimensional points together.
PointN	/	double	PointN	Divide a point by a factor.
PointN	*	double	PointN	Multiply a point by a factor.
PointN	-	PointN	PointN	Subtract two multi-dimensional points. If the points do not share their dimensionality, the results will be meaningless and exceptions may be thrown.