vec2d

README

vec2d

generic 2D vector for golang

Documentation

Index

• type V
  • func New[T numeric](x, y T) (r V[T])
  • func (v V[T]) Abs() (r V[T])
  • func (v V[T]) Add(n V[T]) (r V[T])
  • func (v V[T]) Ceil() (r V[T])
  • func (v V[T]) Cross(n V[T]) (r T)
  • func (v V[T]) Div(n V[T]) (r V[T])
  • func (v V[T]) DivScalar(n T) (r V[T])
  • func (v V[T]) Dot(n V[T]) (r T)
  • func (v V[T]) Floor() (r V[T])
  • func (v V[T]) Len() (r T)
  • func (v V[T]) Max(n V[T]) (r V[T])
  • func (v V[T]) Min(n V[T]) (r V[T])
  • func (v V[T]) Mul(n V[T]) (r V[T])
  • func (v V[T]) MulScalar(n T) (r V[T])
  • func (v V[T]) Neg() (r V[T])
  • func (v V[T]) Norm() (r V[T])
  • func (v V[T]) String() (rv string)
  • func (v V[T]) Sub(n V[T]) (r V[T])

Types

type V

type V[T numeric] struct {
	X, Y T
}

V represents 2D vector.

func New

func New[T numeric](x, y T) (r V[T])

New creates new vector with given coordinates.

func (V[T]) Abs

func (v V[T]) Abs() (r V[T])

Abs returns vector of absolute values.

func (V[T]) Add

func (v V[T]) Add(n V[T]) (r V[T])

Add performs vector addition.

func (V[T]) Ceil

func (v V[T]) Ceil() (r V[T])

Ceil returns rounded-up vector.

func (V[T]) Cross

func (v V[T]) Cross(n V[T]) (r T)

Cross calculates cross-product.

func (V[T]) Div

func (v V[T]) Div(n V[T]) (r V[T])

Div performs vector division.

func (V[T]) DivScalar

func (v V[T]) DivScalar(n T) (r V[T])

DivScalar performs vector * scalar division.

func (V[T]) Dot

func (v V[T]) Dot(n V[T]) (r T)

Dot calculates dot-product.

func (V[T]) Floor

func (v V[T]) Floor() (r V[T])

Floor returns rounded-down vector.

func (V[T]) Len

func (v V[T]) Len() (r T)

Len calculates length of vector.

func (V[T]) Max

func (v V[T]) Max(n V[T]) (r V[T])

Max returns maximum of two vectors.

func (V[T]) Min

func (v V[T]) Min(n V[T]) (r V[T])

Min returns minimum of two vectors.

func (V[T]) Mul

func (v V[T]) Mul(n V[T]) (r V[T])

Mul performs vector multiplication.

func (V[T]) MulScalar

func (v V[T]) MulScalar(n T) (r V[T])

MulScalar performs vector * scalar multiplication.

func (V[T]) Neg

func (v V[T]) Neg() (r V[T])

Neg returns negative vector.

func (V[T]) Norm

func (v V[T]) Norm() (r V[T])

Norm calculates normal vector.

func (V[T]) String

func (v V[T]) String() (rv string)

String returns string representation of vector.

func (V[T]) Sub

func (v V[T]) Sub(n V[T]) (r V[T])

Sub performs vector subtraction.