|
EuclideanWrap Method
|
Wraps a value to a range of values defined
by the given minimum value and range.
Namespace: GSF.NumericalAnalysisAssembly: GSF.Core (in GSF.Core.dll) Version: 2.4.218-beta+101eee949414e414795e55a6e73d88938f0177b8
Syntax GSF.NumericalAnalysis.Euclidean.Wrap = function(value, minimum, range);
View SourceParameters
- value Double
- The value to be wrapped.
- minimum Double
- The minimum value of the range.
- range Double
- The size of the range.
Return Value
DoubleThe given value wrapped to the given range.
Remarks
This method wraps the given value based on the assumption that
for every pair of values x and y where x-y=range, the values are
equivalent. This is probably most widely understood in terms of
angles, where 0, 360, 720, etc. are all equivalent angles. If
you wanted to wrap an angle such that it is between 120 and 480,
for instance, you could call Euclidean.Wrap(angle, 120, 360).
See Also