noise

Documentation

Index

• type Gaussian
  • func NewGaussian(mean []float64, cov mat.Symmetric) (*Gaussian, error)
  • func (g *Gaussian) Cov() mat.Symmetric
  • func (g *Gaussian) Mean() []float64
  • func (g *Gaussian) Reset()
  • func (g *Gaussian) Sample() mat.Vector
  • func (g *Gaussian) String() string
• type None
  • func NewNone() (*None, error)
  • func (e *None) Cov() mat.Symmetric
  • func (e *None) Mean() []float64
  • func (e *None) Reset()
  • func (e *None) Sample() mat.Vector
  • func (e *None) String() string
• type Zero
  • func NewZero(size int) (*Zero, error)
  • func (e *Zero) Cov() mat.Symmetric
  • func (e *Zero) Mean() []float64
  • func (e *Zero) Reset()
  • func (e *Zero) Sample() mat.Vector
  • func (e *Zero) String() string

Types

type Gaussian

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

Gaussian is gaussian noise

func NewGaussian

func NewGaussian(mean []float64, cov mat.Symmetric) (*Gaussian, error)

NewGaussian creates new Gaussian noise with given mean and covariance. It returns error if it fails to create Gaussian distribution handle.

func (*Gaussian) Cov

func (g *Gaussian) Cov() mat.Symmetric

Cov returns covariance matrix of Gaussian noise.

func (*Gaussian) Mean

func (g *Gaussian) Mean() []float64

Mean returns Gaussian mean.

func (*Gaussian) Reset

func (g *Gaussian) Reset()

Reset resets Gaussian noise: it resets the noise seed. It returns error if it fails to reset the noise.

func (*Gaussian) Sample

func (g *Gaussian) Sample() mat.Vector

Sample generates a random sample from Gaussian distribution and returns it.

func (*Gaussian) String

func (g *Gaussian) String() string

String implements the Stringer interface.

type None

type None struct{}

None is noise with empty mean and zero covariance matrix. None is different from None: its mean vector length is 0 and its covariance matrix is zero size.

func NewNone

func NewNone() (*None, error)

NewNone creates new None noise and returns it

func (*None) Cov

func (e *None) Cov() mat.Symmetric

Cov returns zero size covariance matrix.

func (*None) Mean

func (e *None) Mean() []float64

Mean returns None mean.

func (*None) Reset

func (e *None) Reset()

Reset does nothing: it's here to implement filter.Noise interface

func (*None) Sample

func (e *None) Sample() mat.Vector

Sample returns zero size vector.

func (*None) String

func (e *None) String() string

String implements the Stringer interface.

type Zero

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

Zero is zero noise i.e. no noise

func NewZero

func NewZero(size int) (*Zero, error)

NewZero creates new zero noise i.e. zero mean and zero covariance. It returns error if size is non-positive.

func (*Zero) Cov

func (e *Zero) Cov() mat.Symmetric

Cov returns empty covariance matrix: symmetric matrix with zero values.

func (*Zero) Mean

func (e *Zero) Mean() []float64

Mean returns Zero mean.

func (*Zero) Reset

func (e *Zero) Reset()

Reset resets Zero noise: it resets the noise seed. It returns error if it fails to reset the noise.

func (*Zero) Sample

func (e *Zero) Sample() mat.Vector

Sample generates empty sample and returns it: a vector with zero values.

func (*Zero) String

func (e *Zero) String() string

String implements the Stringer interface.