matrix

Documentation

Overview

Package matrix provides basic matrix operations.

Index

• Variables
• type Matrix
  • func Diag(es ...float64) *Matrix
  • func Eye(m, n int) *Matrix
  • func Load(r io.Reader) (a *Matrix, err error)
  • func LoadFile(name string) (*Matrix, error)
  • func NormRand(m, n int) *Matrix
  • func Ones(m, n int) *Matrix
  • func Rand(m, n int) *Matrix
  • func Vector(es ...float64) *Matrix
  • func Zeros(m, n int) *Matrix
  • func (a *Matrix) Add(b *Matrix) *Matrix
  • func (a *Matrix) Copy() *Matrix
  • func (a *Matrix) Det() float64
  • func (a *Matrix) Dim() (int, int)
  • func (a *Matrix) Div(b *Matrix) *Matrix
  • func (a *Matrix) Dump(w io.Writer) error
  • func (a *Matrix) DumpFile(name string) error
  • func (a *Matrix) Get(i, j int) float64
  • func (a *Matrix) Inv() *Matrix
  • func (a *Matrix) Mul(b *Matrix) *Matrix
  • func (a *Matrix) Scale(s float64) *Matrix
  • func (a *Matrix) Set(i, j int, e float64) *Matrix
  • func (a *Matrix) String() string
  • func (a *Matrix) Sub(b *Matrix) *Matrix
  • func (a *Matrix) Tran() *Matrix

Examples

• Matrix

Variables

var (
	ErrInvalidDim     = errors.New("matrix: invalid dimension")
	ErrInvalidMatrix  = errors.New("matrix: invalid matrix")
	ErrSingularMatrix = errors.New("matrix: singular matrix")
)

Errors.

Types

type Matrix

type Matrix struct {
	// contains filtered or unexported fields
}

Matrix represents a matrix.

Example

package main

import (
	"fmt"
	"log"

	"gitee.com/ofunc/matrix"
)

func main() {
	const filename = "example.out"
	// Create random matrix.
	a := matrix.Rand(8, 8)
	b := matrix.Rand(8, 8)

	// Do mul operation.
	c := a.Mul(b)

	// DumpFile dumps the matrix to file.
	if err := c.DumpFile(filename); err != nil {
		log.Fatal(err)
	}

	// LoadFile loads the matrix from file.
	d, err := matrix.LoadFile(filename)
	if err != nil {
		log.Fatal(err)
	}

	// Print the matrix.
	fmt.Println(d)
}

func Diag

func Diag(es ...float64) *Matrix

Diag creates a diagonal matrix.

func Eye

func Eye(m, n int) *Matrix

Eye creates a eye matrix.

func Load

func Load(r io.Reader) (a *Matrix, err error)

Load loads a matrix from io.Reader.

func LoadFile

func LoadFile(name string) (*Matrix, error)

LoadFile loads a matrix from file.

func NormRand

func NormRand(m, n int) *Matrix

NormRand creates a normally random matrix.

func Ones

func Ones(m, n int) *Matrix

Ones creates a ones matrix.

func Rand

func Rand(m, n int) *Matrix

Rand creates a random matrix.

func Vector

func Vector(es ...float64) *Matrix

Vector creates a vector.

func Zeros

func Zeros(m, n int) *Matrix

Zeros creates a zeros matrix.

func (*Matrix) Add

func (a *Matrix) Add(b *Matrix) *Matrix

Add dones the add operation.

func (*Matrix) Copy

func (a *Matrix) Copy() *Matrix

Copy makes a copy of the matrix.

func (*Matrix) Det

func (a *Matrix) Det() float64

Det returns the determinant.

func (*Matrix) Dim

func (a *Matrix) Dim() (int, int)

Dim returns the matrix dimension.

func (*Matrix) Div

func (a *Matrix) Div(b *Matrix) *Matrix

Div dones the div operation.

func (*Matrix) Dump

func (a *Matrix) Dump(w io.Writer) error

Dump dumps a matrix to io.Writer.

func (*Matrix) DumpFile

func (a *Matrix) DumpFile(name string) error

DumpFile dumps a matrix to file.

func (*Matrix) Get

func (a *Matrix) Get(i, j int) float64

Get gets the element by index.

func (*Matrix) Inv

func (a *Matrix) Inv() *Matrix

Inv returns the inverse matrix.

func (*Matrix) Mul

func (a *Matrix) Mul(b *Matrix) *Matrix

Mul dones the mul operation.

func (*Matrix) Scale

func (a *Matrix) Scale(s float64) *Matrix

Scale returns the scaled matrix.

func (*Matrix) Set

func (a *Matrix) Set(i, j int, e float64) *Matrix

Set sets the element by index.

func (*Matrix) String

func (a *Matrix) String() string

String returns the matrix as string.

func (*Matrix) Sub

func (a *Matrix) Sub(b *Matrix) *Matrix

Sub dones the sub operation.

func (*Matrix) Tran

func (a *Matrix) Tran() *Matrix

Tran returns the transposed matrix.