Math.Vector2

A high performance linear algebra library using native Elm ADT.

Create

type Vec a

= Vec a a

Two dimensional vector type

vec2 : a -> a -> Vec a

Creates a new 2-element vector with the given values.

Get and Set

The set functions create a new copy of the vector, updating a single field.

getX : Vec a -> a

Extract the x component of a vector.

getY : Vec a -> a

Extract the y component of a vector.

setX : a -> Vec a -> Vec a

Update the x component of a vector, returning a new vector.

setY : a -> Vec a -> Vec a

Update the y component of a vector, returning a new vector.

Operations

add : Vec number -> Vec number -> Vec number

Vector addition: a + b

sub : Vec number -> Vec number -> Vec number

Vector subtraction: a - b

negate : Vec number -> Vec number

Vector negation: -a

scale : number -> Vec number -> Vec number

Multiply the vector by a scalar: s * v

divBy : Float -> Vec Float -> Vec Float

Divide the vector by a scalar: v / s

Shorthand for scale (1 / s)

dot : Vec number -> Vec number -> number

The dot product of a and b

mul : Vec number -> Vec number -> Vec number

Component-wise multiplication

normalize : Vec Float -> Vec Float

A unit vector with the same direction as the given vector: a / |a|

direction : Vec Float -> Vec Float -> Vec Float

The normalized direction from b to a: (a - b) / |a - b|

length : Vec Float -> Float

The length of the given vector: |a|

lengthSquared : Vec number -> number

The square of the length of the given vector: |a| * |a|

distance : Vec Float -> Vec Float -> Float

The distance between two vectors.

distanceSquared : Vec number -> Vec number -> number

The square of the distance between two vectors.

Transform

mapX : (a -> a) -> Vec a -> Vec a

Map a fn to the x value

mapY : (a -> a) -> Vec a -> Vec a

Map a fn to the y value

map : (a -> b) -> Vec a -> Vec b

Map a fn to the x and y value

apply : Vec (a -> b) -> Vec a -> Vec b

lift2 : (a -> b -> c) -> Vec a -> Vec b -> Vec c

Lift a binary function to vectors.

lift2 (+) (Vec 1 1) (Vec 2 2)
--> Vec 3 3 : Vec number

Keep in mind that this comes at a cost of doing a step extra and if you need performance, you might be better off deconstructing and applying the function manually.

lift3 : (a -> b -> c -> d) -> Vec a -> Vec b -> Vec c -> Vec d

Conversions

toRecord :

Vec a

-> { x : a

, y : a

}

Convert a vector to a record.

fromRecord :

{ x : a

, y : a

}

-> Vec a

Construct a vector from a record.

fromTuple : ( a, a ) -> Vec a

Construct a vector from a tuple.

toFloat : Vec Int -> Vec Float

Convert an integer vector into a float vector.

round : Vec Float -> Vec Int

Round the number components to the nearest integer.

floor : Vec Float -> Vec Int

Floor function, rounding down.

ceiling : Vec Float -> Vec Int

Ceiling function, rounding up.

truncate : Vec Float -> Vec Int

Truncate the number components, rounding towards zero.

escherlies/elm-vectors/1.1.0