hashtron

Documentation

Overview

Package Hashtron implements a hashtron (classifier)

Index

• type Hashtron
  • func New(program [][2]uint32, bits byte, future ...interface{}) (h *Hashtron, err error)
  • func (h Hashtron) Bits() byte
  • func (h Hashtron) BytesBuffer(name string, eol ...byte) (b *bytes.Buffer, err error)
  • func (h Hashtron) Forward(sample uint32, negate bool) (out uint64)
  • func (h Hashtron) Get(n int) (s uint32, max uint32)
  • func (h Hashtron) Len() int
  • func (h *Hashtron) ReadJson(b io.Reader) error
  • func (h Hashtron) SetBits(bits byte)
  • func (h Hashtron) WriteJson(b io.Writer, eol ...byte) error

Types

type Hashtron

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

Hashtron represents individual hashtron (classifier) in memory

func New

func New(program [][2]uint32, bits byte, future ...interface{}) (h *Hashtron, err error)

New creates a new hashtron (giving pseudo random output), or initialized using a provided program and bits

func (Hashtron) Bits

func (h Hashtron) Bits() byte

Bits determines the number of output bits returned by hashtron using Forward

func (Hashtron) BytesBuffer

func (h Hashtron) BytesBuffer(name string, eol ...byte) (b *bytes.Buffer, err error)

BytesBuffer serializes hashtron into a golang code program

func (Hashtron) Forward

func (h Hashtron) Forward(sample uint32, negate bool) (out uint64)

Forward calculates the hashtron output on single feaure sample (32 bit uint)

func (Hashtron) Get

func (h Hashtron) Get(n int) (s uint32, max uint32)

Get gets the hashing command at position n

func (Hashtron) Len

func (h Hashtron) Len() int

Len gets the number of hashing commands (size of hashtron program)

func (*Hashtron) ReadJson

func (h *Hashtron) ReadJson(b io.Reader) error

ReadJson deserializes hashtron from a pre-xorred json io.Reader

func (Hashtron) SetBits

func (h Hashtron) SetBits(bits byte)

SetBits sets the number of output bits returned by hashtron using Forward

func (Hashtron) WriteJson

func (h Hashtron) WriteJson(b io.Writer, eol ...byte) error

WriteJson serializes hashtron into a pre-xorred json io.Writer