numberutils.md

dastal - v5.0.0 / NumberUtils

Namespace: NumberUtils

Table of contents

Functions

• clamp
• wrap
• wrapLeft
• wrapRight

Functions

clamp

▸ clamp(num, min, max): number

Limits a number to be within a given range.

f(x, min, max) = y, where min <= y <= max

Parameters

Name	Type	Description
num	number	The number to clamp
min	number	The minimum result value, inclusive
max	number	The maximum result value, inclusive

Returns

number

The clamped number

Defined in

src/math/numberUtils.ts:12

---

wrap

▸ wrap(num, min, max): number

Wraps a number if outside a given range

Parameters

Name	Type	Description
num	number	The number to wrap
min	number	The minimum result value, inclusive
max	number	The maximum result value, inclusive

Returns

number

• The wrapped number

Defined in

src/math/numberUtils.ts:58

---

wrapLeft

▸ wrapLeft(num, min, max): number

Wraps a number if below a given range

f(x, min, max) = { x, where x >= min max - (min - x), where x < min }

Parameters

Name	Type	Description
num	number	The number to wrap
min	number	The minimum result value, inclusive
max	number	The maximum result value, inclusive

Returns

number

• The wrapped number

Defined in

src/math/numberUtils.ts:29

---

wrapRight

▸ wrapRight(num, min, max): number

Wraps a number if above a given range

f(x, min, max) = { x, where x <= max min + (x - max), where x > max }

Parameters

Name	Type	Description
num	number	The number to wrap
min	number	The minimum result value, inclusive
max	number	The maximum result value, inclusive

Returns

number

• The wrapped number

Defined in

src/math/numberUtils.ts:46