ScottPlot
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Properties | List of all members
ScottPlot.Range Struct Reference

Represents a range between any two finite values (inclusive) /summary> More...

Public Member Functions

 Range (double min, double max)
 
override string ToString ()
 
double Normalize (double value, bool clamp=false)
 Returns the given value as a fraction of the difference between Min and Max. This is a min-max feature scaling.
 
double Clamp (double value)
 

Static Public Member Functions

static Range GetRange (double[,] input)
 
static Range GetRange (IEnumerable< double > input)
 

Properties

double Min [get]
 
double Max [get]
 

Detailed Description

Represents a range between any two finite values (inclusive) /summary>

Constructor & Destructor Documentation

◆ Range()

ScottPlot.Range.Range ( double  min,
double  max 
)
inline

Member Function Documentation

◆ Clamp()

double ScottPlot.Range.Clamp ( double  value)
inline

◆ GetRange() [1/2]

static Range ScottPlot.Range.GetRange ( double  input[,])
inlinestatic

◆ GetRange() [2/2]

static Range ScottPlot.Range.GetRange ( IEnumerable< double >  input)
inlinestatic

◆ Normalize()

double ScottPlot.Range.Normalize ( double  value,
bool  clamp = false 
)
inline

Returns the given value as a fraction of the difference between Min and Max. This is a min-max feature scaling.

Parameters
valueThe value to normalize
clampIf true, values outside of the range will be clamped onto the interval [0, 1].
Returns
The normalized value

summary> Returns the given value clamped to the range (inclusive). /summary>

◆ ToString()

override string ScottPlot.Range.ToString ( )
inline

Property Documentation

◆ Max

double ScottPlot.Range.Max
get

◆ Min

double ScottPlot.Range.Min
get

The documentation for this struct was generated from the following file: