Surface.Evaluate Method

Definition

Namespace: Numerics.NET.Curves.Surfaces
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.1.0

Overload List

Evaluate(Double[]) Evaluates the surface at the specified point.
Evaluate(IReadOnlyList<Double>) Evaluates the surface at the specified point.
Evaluate(ReadOnlySpan<Double>) Evaluates the surface at the specified point.
Evaluate(IReadOnlyList<Vector<Double>>, Span<Double>) Evaluates the surface at multiple points specified by a list of vectors.
Evaluate(ReadOnlySpan<Vector<Double>>, Span<Double>) Evaluates the surface at multiple points specified by a read-only span of vectors.
Evaluate(Int32, ReadOnlySpan2D<Double>, Span<Double>) Evaluates the surface at multiple points stored in column-major layout.

Evaluate(Double[])

Evaluates the surface at the specified point.
C#
public virtual double Evaluate(
	double[] point
)

Parameters

point  Double[]
A read-only list representing the coordinates of the point.

Return Value

Double
The value of the surface at the specified point.

Remarks

The length of point must equal Dimension.

Exceptions

ArgumentException The length of point does not equal Dimension.

Evaluate(IReadOnlyList<Double>)

Evaluates the surface at the specified point.
C#
public virtual double Evaluate(
	IReadOnlyList<double> point
)

Parameters

point  IReadOnlyList<Double>
A read-only list representing the coordinates of the point.

Return Value

Double
The value of the surface at the specified point.

Remarks

The length of point must equal Dimension.

Exceptions

ArgumentException The length of point does not equal Dimension.

Evaluate(ReadOnlySpan<Double>)

Evaluates the surface at the specified point.
C#
public abstract double Evaluate(
	ReadOnlySpan<double> point
)

Parameters

point  ReadOnlySpan<Double>
A read-only span representing the coordinates of the point.

Return Value

Double
The value of the surface at the specified point.

Remarks

The length of point must equal Dimension.

Exceptions

ArgumentException The length of point does not equal Dimension.

Evaluate(IReadOnlyList<Vector<Double>>, Span<Double>)

Evaluates the surface at multiple points specified by a list of vectors.
C#
public virtual void Evaluate(
	IReadOnlyList<Vector<double>> points,
	Span<double> destination
)

Parameters

points  IReadOnlyList<Vector<Double>>
A read-only list of vectors, where each vector represents a point in N-dimensional space.
destination  Span<Double>
A span to receive the computed values.

Remarks

This method evaluates the surface at each point in points and stores the results in destination.

The default implementation loops through the list and calls Evaluate(ReadOnlySpan<Double>) for each point.

Exceptions

ArgumentNullExceptionpoints is null.
ArgumentException

Any vector in points has a length that does not equal Dimension.

-or-

destination is shorter than the number of points.

Evaluate(ReadOnlySpan<Vector<Double>>, Span<Double>)

Evaluates the surface at multiple points specified by a read-only span of vectors.
C#
public virtual void Evaluate(
	ReadOnlySpan<Vector<double>> points,
	Span<double> destination
)

Parameters

points  ReadOnlySpan<Vector<Double>>
A read-only span of vectors, where each vector represents a point in N-dimensional space.
destination  Span<Double>
A span to receive the computed values.

Remarks

This method evaluates the surface at each point in points and stores the results in destination.

The default implementation loops through the vectors and calls Evaluate(ReadOnlySpan<Double>) for each point.

Exceptions

ArgumentException

Any vector in points has a length that does not equal Dimension.

-or-

destination is shorter than the number of points.

Evaluate(Int32, ReadOnlySpan2D<Double>, Span<Double>)

Evaluates the surface at multiple points stored in column-major layout.
C#
public virtual void Evaluate(
	int pointCount,
	ReadOnlySpan2D<double> points,
	Span<double> destination
)

Parameters

pointCount  Int32
The number of points (columns) in the 2D span.
points  ReadOnlySpan2D<Double>
A 2D span containing the points in column-major order, where each column represents one point (with pointCount columns) and each row represents a coordinate dimension (with Dimension rows).
destination  Span<Double>
A span to receive the computed values.

Remarks

This method evaluates the surface at each point stored as a column in points and stores the results in destination.

The points are stored in column-major order: point i has coordinates (points[0,i], points[1,i], ..., points[Dimension-1,i]).

The default implementation loops through the columns and calls Evaluate(ReadOnlySpan<Double>) for each point. Derived classes may override this method to provide more efficient batch evaluation.

Exceptions

ArgumentException

The row count of points does not equal Dimension.

-or-

destination is shorter than pointCount.

See Also