IndexRange
Defines a range used to specify array indices to another series
Constructors
public IndexRange()
indexRange = IndexRange()
Initializes a new instance of the IndexRange class.
public IndexRange(int min, int max)
indexRange = IndexRange(min, max)
Initializes a new instance of the IndexRange class.
- min
- The min.
- max
- The max.
Properties
public override int Diff { get; }
value = indexRange.Diff
Gets the Diff (Max - Min) of this range
public override bool IsDefined { get; }
value = indexRange.IsDefined
Gets whether this Range is defined
public override bool IsZero { get; }
value = indexRange.IsZero
Gets whether the range is Zero, where Max equals Min
Methods
public override DoubleRange AsDoubleRange()
result = indexRange.AsDoubleRange()
Converts this range to a DoubleRange, which are used internally for calculations
public override IRange<int> ClipTo(IRange<int> maximumRange)
result = indexRange.ClipTo(maximumRange)
Clips the current IRange to a maxmimum range
- maximumRange
- The Maximum Range
Returns: This instance, after the operation
public override IRange<int> GrowBy(double minFraction, double maxFraction)
result = indexRange.GrowBy(minFraction, maxFraction)
Grows the current IRange by the min and max fraction, returning this instance after modification
- minFraction
- The Min fraction to grow by. For example, Min = -10 and minFraction = 0.1 will result in the new Min = -11
- maxFraction
- The Max fraction to grow by. For example, Max = 10 and minFraction = 0.2 will result in the new Max = 12
Returns: This instance, after the operation
public override IRange<int> SetMinMax(double min, double max)
result = indexRange.SetMinMax(min, max)
Sets the Min, Max values on the IRange, returning this instance after modification
- min
- The new Min value.
- max
- The new Max value.
Returns: This instance, after the operation
public override IRange<int> SetMinMax(double min, double max, IRange<int> maxRange)
result = indexRange.SetMinMax(min, max, maxRange)
Sets the Min, Max values on the IRange with a max range to clip values to, returning this instance after modification
- min
- The new Min value.
- max
- The new Max value.
- maxRange
- The max range, which is used to clip values.
Returns: This instance, after the operation