Table of Contents

Class CFieldDerivative2DReal

Namespace
VirtualLabAPI.Core.Numerics
Assembly
VirtualLabAPI.dll

Derivative of ComplexField for two-dimensional, real-valued data.

[Serializable]
public class CFieldDerivative2DReal : ComplexField, ILargeArray<Complex>, ICloneable, IDisposable
Inheritance
CFieldDerivative2DReal
Implements
Inherited Members

Constructors

CFieldDerivative2DReal()

Creates a CFieldDerivative2DReal with 3 × 3 sampling points filled with zeros.

public CFieldDerivative2DReal()

CFieldDerivative2DReal(CFieldDerivative2DReal)

Copy constructor.

public CFieldDerivative2DReal(CFieldDerivative2DReal field)

Parameters

field CFieldDerivative2DReal

Field to copy.

CFieldDerivative2DReal(ComplexField)

Constructor that uses an object of type ComplexField whereas IsComplex must be true.

public CFieldDerivative2DReal(ComplexField cf)

Parameters

cf ComplexField

ComplexField to be converted.

Exceptions

ArgumentException

Only real-valued complex fields can be arguments for this constructor.

CFieldDerivative2DReal(Vector, bool)

Creates a CFieldDerivative2DReal with given number of sampling points.

public CFieldDerivative2DReal(Vector samplingPoints, bool initializeValues = true)

Parameters

samplingPoints Vector

Number of points in x- and y-direction.

initializeValues bool

If this optional parameter is set to false, the field values are not initialized. Should be used only if the values are initialized immediately afterwards, but then performance is better.

CFieldDerivative2DReal(Vector, double)

Creates a CFieldDerivative2DReal with given number of sampling points. Field is filled with the given constant value.

public CFieldDerivative2DReal(Vector samplingPoints, double value)

Parameters

samplingPoints Vector

Number of points in x- and y-direction.

value double

Real number with which the field is to be initialized.

Properties

IsComplex

Overrides a property in base class ComplexField. This will return always false for objects of type CFieldDerivative2DReal.

public override bool IsComplex { get; set; }

Property Value

bool

this[long, long]

Indexer to access double values of complex field. Property performs a range checking before every access. If you try to read a double value and index is out of range 0.0 is returned. If you try to set a double value and index is out of range nothing will happen. Indexer returns always a double number in double precision independent on the internal complex number representation. During the setting of a double value the indexer converts the double number from double precision to the internal data representation. If internal precision is less accurate double precision information will be lost. Conversion to the less accurate precision is done by truncating the numbers after the last digit of the new precision.

public double this[long x, long y] { get; set; }

Parameters

x long

Index for x-coordinate.

y long

Index for y-coordinate.

Property Value

double

Methods

Clone()

Clones this complex field.

public override object Clone()

Returns

object

ConvertTo2DDoubleArray()

Public support method to convert the complex field into a double array.

public double[,] ConvertTo2DDoubleArray()

Returns

double[,]

This data converted to a 2D double array.