@litecanvas/utils/src/math/README.md

Utilities to help build litecanvas games

# Math utilities

**CDN**: https://unpkg.com/@litecanvas/utils/dist/math.js

## diff

Calculates the positive distance/difference of two given numbers.

Syntax: `diff(a: number, b: number): number`

```js
import litecanvas from "litecanvas"
import { diff } from "@litecanvas/utils"

litecanvas({
  loop: { init },
})

function init() {
  console.log(diff(10, 5)) // outputs 5
  console.log(diff(-10, 5)) // outputs 15
}
```

## fract

Returns the fractional part of a number.

Syntax: `fract(value: number): number`

```js
import litecanvas from "litecanvas"
import { fract } from "@litecanvas/utils"

litecanvas({
  loop: { init },
})

function init() {
  console.log(fract(5.9)) // outputs 0.9
}
```

## advance

Move a vector (position) using another vectors: velocity (required) and acceleration (optional).

> Note: This function changes the position and velocity vectors.

Syntax: `advance(position: Vector, velocity: Vector, acceleration?: Vector, delta?: number): void`

```js
import litecanvas from "litecanvas"
import { vec, advance } from "@litecanvas/utils"

litecanvas()

function init() {
  pos = vec(0, H / 2)
  vel = vec(0, 0)
  acc = vec(100, 0)
}

function update(dt) {
  advance(pos, vel, acc, dt)
  if (pos.x > W) {
    pos.x = 0
  }
}

function draw() {
  cls(0)
  circ(pos.x, pos.y, 48, 4)
}
```

[See in playground](https://litecanvas.js.org?c=eJxVjjELwjAQhff%2BihtTCKWCg0tdtKCLgxTEMV5SCYS0NGlUpP%2FdS1NQhxvue7yPN3ptXHE33U0YlmdGe4XCBuHoydrRotedBW21Zzm8M4C%2Bc1BBUMhKDrv61NTna048KPPlZSQCcSGrMrHpRzn2UnjFpE9aIYOwqBjpeXTxWOdAMYW6hRgUT9jC5bhvDqkzjyFYQUnf9KeXg3gsi9E4Ng9CPWDy8Ln54rDe0NGwDwbOS1Q%3D)

## mod

Math modulus (always returns a positive number).

Syntax: `mod(dividend: number, divisor: number): number`

```js
import { mod } from "@litecanvas/utils"

mod(17, 5) // => 2
mod(-17, 5) // => 3
```

## mean

Computes the mean of the values in a array.

```js
import { mean } from "@litecanvas/utils"

Syntax: `mean(values: number[]): number`

mean([10, 5, 3]) // => 6 or (10 + 5 + 3) / 3
```

## sum

Computes the sum of the values in a array.

Syntax: `sum(values: number[]): number`

```js
import { sum } from "@litecanvas/utils"

sum([10, 5, 3]) // => 18 or (10 + 5 + 3)
```

## lerpAngle

Calculates the linear interpolation of two angles (in degrees).

Syntax: `lerpAngle(start: number, end: number, amount: number): number`

```js
import { lerpAngle } from "@litecanvas/utils"

lerpAngle(0, 90, 0.5) // => 45
lerpAngle(0, 270, 0.5) // => -45
```