ComplexField1DArray Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class to encapsulate an array of objects of type ComplexFieldDerivative1D. It also ensures that all entries are either complex or real valued. More...

Inheritance diagram for ComplexField1DArray:

Public Member Functions
void	AddRange (ComplexField1DArray arrayToAdd)
	Adds a range of complex fields, provided by another ComplexField1DArray, to this.
override object	Clone ()
	Creates a deep copy of this ComplexField1DArray object.
	ComplexField1DArray ()
	Default constructor. Creates an empty array of length 1.
	ComplexField1DArray (ComplexField1DArray array)
	Copy constructor.
	ComplexField1DArray (ComplexField[] array)
	Constructor that gets an array of equally sized ComplexFieldDerivative1D objects.
	ComplexField1DArray (ComplexFieldDerivative1D[] array)
	Constructor that gets an array of equally sized ComplexFieldDerivative1D objects.
	ComplexField1DArray (long length)
	Constructor that creates an empty array of a given length.
	ComplexField1DArray (long length, long lengthOfComplexFields, bool isComplex, PrecisionMode precision=PrecisionMode.Double)
	Initializes a new instance of the ComplexField1DArray class.
void	Dispose ()
	Frees all memory that is used to store the data.
override bool	Equals (object otherObject, EqualityIntent equalityIntent)
ComplexFieldDerivative1D[]	ToArray (bool cloneFields=true)
	Returns this class as array of ComplexFieldDerivative1D.

Static Public Member Functions
static bool	operator!= (ComplexField1DArray cf1, ComplexField1DArray cf2)
	Checks whether two ComplexField1DArray objects are unequal.
static bool	operator== (ComplexField1DArray cf1, ComplexField1DArray cf2)
	Checks whether two ComplexField1DArray objects are equal.

Properties
int	Length [get]
	Gets the length of the array.
int	SamplingPoints [get]
	Gets the number of SamplingPoints. Returns (0) for an empty array.
ComplexFieldDerivative1D	this[long index] [get, set]
	Indexer to get or set a contained ComplexFieldDerivative1D object.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class to encapsulate an array of objects of type ComplexFieldDerivative1D. It also ensures that all entries are either complex or real valued.

Constructor & Destructor Documentation

ComplexField1DArray() [1/5]

ComplexField1DArray

(

ComplexFieldDerivative1D[]

array

)

Constructor that gets an array of equally sized ComplexFieldDerivative1D objects.

Parameters

array

One or more ComplexFieldDerivative1D objects or an array of ComplexFieldDerivative1D objects.

ComplexField1DArray() [2/5]

ComplexField1DArray

(

ComplexField[]

array

)

Constructor that gets an array of equally sized ComplexFieldDerivative1D objects.

Parameters

array

One or more ComplexField objects or an array of ComplexField objects.

ComplexField1DArray() [3/5]

ComplexField1DArray

(

ComplexField1DArray

array

)

Copy constructor.

Parameters

array

ComplexField1DArray to copy

ComplexField1DArray() [4/5]

ComplexField1DArray

(

long

length

)

Constructor that creates an empty array of a given length.

Parameters

length

Length of the array to create.

ComplexField1DArray() [5/5]

ComplexField1DArray	(	long	length,
		long	lengthOfComplexFields,
		bool	isComplex,
		PrecisionMode	precision = PrecisionMode::Double
	)

Initializes a new instance of the ComplexField1DArray class.

Parameters

length	The number of entries in the array.
lengthOfComplexFields	The number of sampling points in one member field.
isComplex	if set to true the member fields are used to store complex numbers.
precision	Optional precision of the new complexFields

Member Function Documentation

AddRange()

void AddRange

(

ComplexField1DArray

arrayToAdd

)

Adds a range of complex fields, provided by another ComplexField1DArray, to this.

Parameters

arrayToAdd

ComplexField1DArray to get the complex fields to add from.

Clone()

override object Clone

(

)

Creates a deep copy of this ComplexField1DArray object.

Returns

Deep copy of this

operator!=()

static bool operator!= ( ComplexField1DArray  cf1, ComplexField1DArray  cf2  )

static

Checks whether two ComplexField1DArray objects are unequal.

Parameters

cf1	The first ComplexField1DArray.
cf2	The second ComplexField1DArray.

Returns

The result of the operator.

operator==()

static bool operator== ( ComplexField1DArray  cf1, ComplexField1DArray  cf2  )

static

Checks whether two ComplexField1DArray objects are equal.

Parameters

cf1	The first ComplexField1DArray.
cf2	The second ComplexField1DArray.

Returns

The result of the operator.

ToArray()

ComplexFieldDerivative1D[] ToArray

(

bool

cloneFields = true

)

Returns this class as array of ComplexFieldDerivative1D.

Parameters

cloneFields

If this optional parameter is set to false, references to the original fields are returned instead of copies.

Returns

An array of ComplexFieldDerivative1D.

Property Documentation

this[long index]

ComplexFieldDerivative1D this[long index]

getset

Indexer to get or set a contained ComplexFieldDerivative1D object.

Parameters

index

Index to access

Returns

ComplexFieldDerivative1D at index index