Class SlicedDoubleArray
- Namespace
- FinanceSharp
- Assembly
- FinanceSharp.dll
Provides a wrapping DoubleArray to contiguously slice.
public class SlicedDoubleArray : DoubleArray, ICloneable, IDisposable, IEquatable<DoubleArray>
- Inheritance
-
SlicedDoubleArray
- Implements
- Inherited Members
- Extension Methods
Constructors
SlicedDoubleArray(DoubleArray, int, int)
public SlicedDoubleArray(DoubleArray slicedArray, int start, int stop)
Parameters
slicedArrayDoubleArraystartintstopint
Fields
internalArray
protected DoubleArray internalArray
Field Value
start
protected int start
Field Value
stop
protected int stop
Field Value
Properties
Count
The number of items in this array, each having n Properties.
public override int Count { get; protected set; }
Property Value
InternalArray
Provides access to the internal array that is being sliced by this class.
public DoubleArray InternalArray { get; }
Property Value
this[int]
Scalar overload.
public override double this[int property] { get; set; }
Parameters
propertyint
Property Value
this[int, int]
public override double this[int index, int property] { get; set; }
Parameters
Property Value
Properties
The count of properties for every
public override int Properties { get; protected set; }
Property Value
Start
Start of interval. The interval includes this value. The default start value is 0.
public int Start { get; }
Property Value
Stop
End of interval. The interval does not include this value, except in some cases where step is not an integer and floating point round-off affects the length of out.
public int Stop { get; }
Property Value
Methods
AdjustIndex(int)
protected int AdjustIndex(int index)
Parameters
indexint
Returns
Clone()
Clones current DoubleArray.
public override DoubleArray Clone()
Returns
- DoubleArray
A new copy of this.
ComputeHashCode()
Additional hashcode for inherieted classes.
protected override int ComputeHashCode()
Returns
ForEach(ReferenceForFunctionHandler)
public override void ForEach(ReferenceForFunctionHandler function)
Parameters
functionReferenceForFunctionHandler
GetPinnableReference()
Provides a pinnable reference for fixing a DoubleArray.
public override ref double GetPinnableReference()
Returns
GetPinnableReference(int)
Provides a pinnable reference for fixing a DoubleArray at a specific index (of Count dimension).
public override ref double GetPinnableReference(int index)
Parameters
indexint
Returns
Examples
fixed (double* pointer = &arr.GetPinnableReference(0)) {
//use pointer to your needs
}
IsEqualExactlyTo(DoubleArray)
A comparison method used when Equals(DoubleArray) is called from IEquatable<T> to compare same types of DoubleArray.
protected override bool? IsEqualExactlyTo(DoubleArray other)
Parameters
otherDoubleArrayAn DoubleArray to compare to this.
Returns
Reshape(int, int, bool)
Reshapes this DoubleArray to a shape of your choice, the shape must be
public override DoubleArray Reshape(int count, int properties, bool copy = true)
Parameters
countintThe count of items in this array.
propertiesintNumber of properties for every item in this array.
copyboolShould a copy be reshaped?
Returns
Remarks
A sliced array always copies.
Exceptions
- ReshapeException
When unable to reshape to reshape: LinearLength != (
count*properties) then throws