Gemstone Numeric Library
Show/Hide TOC

# EuclideanWrap Method

Wraps a value to a range of values defined by the given minimum value and range.

## Definition

Namespace: Gemstone.Numeric.Analysis
Assembly: Gemstone.Numeric (in Gemstone.Numeric.dll) Version: 1.0.173 -- Release Build+f98ef614814d50c1f66a919b6c587a372a50e4bf
C#
View Source Request Example

    public static double Wrap(
    	double value,
    	double minimum,
    	double range
    )

VB
View Source Request Example

    Public Shared Function Wrap (
    	value As Double,
    	minimum As Double,
    	range As Double
    ) As Double

C++
View Source Request Example

    public:
    static double Wrap(
    	double value,
    	double minimum,
    	double range
    )

JavaScript
View Source Request Example

    Gemstone.Numeric.Analysis.Euclidean.Wrap = function(value, minimum, range);

#### Parameters

value Double
  The value to be wrapped.
minimum Double
  The minimum value of the range.
range Double
  The size of the range.

#### Return Value

Double
The 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

#### Reference

Euclidean Class
Gemstone.Numeric.Analysis Namespace