vector

Documentation

Overview

Package vector defines an n-dimensional vector. The mutable / immutable syntax is based loosely off of the github.com/kvartborg/vector implementation.

Index

• func Dot(v V, u V) float64
• func IsOrthogonal(v V, u V) bool
• func Magnitude(v V) float64
• func SquaredMagnitude(v V) float64
• func Within(v V, u V) bool
• func WithinEpsilon(v V, u V, e epsilon.E) bool
• type D
• type M
  • func (v M) Add(u V)
  • func (v M) Copy(u V)
  • func (v M) Dimension() D
  • func (v M) Scale(c float64)
  • func (v M) SetX(i D, c float64)
  • func (v M) Sub(u V)
  • func (v M) Unit()
  • func (v M) V() V
  • func (v M) X(i D) float64
  • func (v M) Zero()
• type V
  • func Add(v V, u V) V
  • func New(xs ...float64) *V
  • func Scale(c float64, v V) V
  • func Sub(v V, u V) V
  • func Unit(v V) V
  • func (v V) Dimension() D
  • func (v V) M() M
  • func (v V) X(i D) float64

Functions

func Dot

func Dot(v V, u V) float64

func IsOrthogonal

func IsOrthogonal(v V, u V) bool

func Magnitude

func Magnitude(v V) float64

func SquaredMagnitude

func SquaredMagnitude(v V) float64

func Within

func Within(v V, u V) bool

func WithinEpsilon

func WithinEpsilon(v V, u V, e epsilon.E) bool

Types

type D

type D int

const (
	// AXIS_X is a common alias for the first dimension.
	AXIS_X D = iota

	// AXIS_Y is a common alias for the second dimension.
	AXIS_Y

	// AXIS_Z is a common alias for the third dimension.
	AXIS_Z

	// AXIS_W is a common alias for the fourth dimension.
	AXIS_W
)

type M

type M []float64

M is a mutable n-dimensional vector.

func (M) Add

func (v M) Add(u V)

func (M) Copy

func (v M) Copy(u V)

func (M) Dimension

func (v M) Dimension() D

func (M) Scale

func (v M) Scale(c float64)

func (M) SetX

func (v M) SetX(i D, c float64)

func (M) Sub

func (v M) Sub(u V)

func (M) Unit

func (v M) Unit()

func (M) V

func (v M) V() V

func (M) X

func (v M) X(i D) float64

func (M) Zero

func (v M) Zero()

type V

type V []float64

V is an immutable n-length vector.

func Add

func Add(v V, u V) V

func New

func New(xs ...float64) *V

func Scale

func Scale(c float64, v V) V

func Sub

func Sub(v V, u V) V

func Unit

func Unit(v V) V

func (V) Dimension

func (v V) Dimension() D

Dimension returns the dimension of the vector.

func (V) M

func (v V) M() M

func (V) X

func (v V) X(i D) float64