Surface.Gradient Method

public Vector<double> Gradient(
	Vector<double> point
)

Public Function Gradient ( 
	point As Vector(Of Double)
) As Vector(Of Double)

public:
Vector<double>^ Gradient(
	Vector<double>^ point
)

member Gradient : 
        point : Vector<float> -> Vector<float> 

Parameters

point  Vector<Double>

A vector representing the coordinates of the point.

Return Value

This is a convenience method that allocates a new vector for the result.

The length of point must equal Dimension.

public virtual (double dx, double dy) Gradient(
	double x,
	double y
)

Public Overridable Function Gradient ( 
	x As Double,
	y As Double
) As (dx As Double, dy As Double)

public:
virtual ValueTuple<double, double> Gradient(
	double x, 
	double y
)

abstract Gradient : 
        x : float * 
        y : float -> ValueTuple<float, float> 
override Gradient : 
        x : float * 
        y : float -> ValueTuple<float, float> 

Parameters

x  Double

The x-coordinate.

y  Double

The y-coordinate.

Return Value

This is a convenience method for 2D surfaces. It internally calls Gradient(ReadOnlySpan<Double>, Span<Double>).

This method is only applicable when Dimension equals 2.

public virtual void Gradient(
	ReadOnlySpan<double> point,
	Span<double> result
)

Public Overridable Sub Gradient ( 
	point As ReadOnlySpan(Of Double),
	result As Span(Of Double)
)

public:
virtual void Gradient(
	ReadOnlySpan<double> point, 
	Span<double> result
)

abstract Gradient : 
        point : ReadOnlySpan<float> * 
        result : Span<float> -> unit 
override Gradient : 
        point : ReadOnlySpan<float> * 
        result : Span<float> -> unit 

Parameters

point  ReadOnlySpan<Double>

A read-only span representing the coordinates of the point.

result  Span<Double>

A span to receive the gradient vector.

The gradient is a vector of partial derivatives with respect to each coordinate dimension.

The length of point must equal Dimension. The length of result must also equal Dimension.

Not all surface types support gradient computation. The default implementation throws NotSupportedException. Override this method in derived classes to provide gradient computation.

For surfaces with extrapolation modes, the gradient respects the same extrapolation behavior as Evaluate(ReadOnlySpan<Double>).

public Vector<double> Gradient(
	Vector<double> point,
	Vector<double>? result
)

Public Function Gradient ( 
	point As Vector(Of Double),
	result As Vector(Of Double)
) As Vector(Of Double)

public:
Vector<double>^ Gradient(
	Vector<double>^ point, 
	Vector<double>^ result
)

member Gradient : 
        point : Vector<float> * 
        result : Vector<float> -> Vector<float> 

Parameters

point  Vector<Double>

A vector representing the coordinates of the point.

result  Vector<Double>

An optional vector to receive the gradient. If null, a new vector is allocated.

Return Value

The length of point must equal Dimension.

If result is non-null, its length must also equal Dimension.

Reference