trinary

Documentation

Overview

Package trinary provides functions for validating and converting Trits and Trytes.

Index

• Variables
• func CanBeHash(trits Trits) bool
• func CanTritsToTrytes(trits Trits) bool
• func MinTrits(value int64) int
• func MustPutTryteTrits(trits []int8, v int8)
• func MustTritsToTryteValue(trits Trits) int8
• func MustTryteToTryteValue(t byte) int8
• func MustTryteValueToTryte(v int8) byte
• func Sum(a int8, b int8) int8
• func TrailingZeros(trits Trits) int
• func TritsEqual(a Trits, b Trits) (bool, error)
• func TritsToInt(t Trits) int64
• func TrytesToInt(t Trytes) int64
• func ValidTrit(t int8) bool
• func ValidTrits(trits Trits) error
• func ValidTryte(t rune) error
• func ValidTrytes(trytes Trytes) error
• type Hash
• type Hashes
• type Trits
  • func AddTrits(a Trits, b Trits) Trits
  • func IntToTrits(value int64, tritsCnt int) Trits
  • func MustPadTrits(trits Trits, n int) Trits
  • func MustTrytesToTrits(trytes Trytes) Trits
  • func NewTrits(t []int8) (Trits, error)
  • func PadTrits(trits Trits, n int) (Trits, error)
  • func ReverseTrits(trits Trits) Trits
  • func TrytesToTrits(trytes Trytes) (Trits, error)
• type Trytes
  • func IntToTrytes(value int64, trytesCnt int) Trytes
  • func MustPad(trytes Trytes, n int) Trytes
  • func MustTritsToTrytes(trits Trits) Trytes
  • func NewTrytes(s string) (Trytes, error)
  • func Pad(trytes Trytes, n int) (Trytes, error)
  • func TritsToTrytes(trits Trits) (Trytes, error)

Variables

var (
	// TryteValueToTritsLUT is a lookup table to convert tryte values into trits.
	TryteValueToTritsLUT = [TryteRadix][TritsPerTryte]int8{
		{-1, -1, -1}, {0, -1, -1}, {1, -1, -1}, {-1, 0, -1}, {0, 0, -1}, {1, 0, -1},
		{-1, 1, -1}, {0, 1, -1}, {1, 1, -1}, {-1, -1, 0}, {0, -1, 0}, {1, -1, 0},
		{-1, 0, 0}, {0, 0, 0}, {1, 0, 0}, {-1, 1, 0}, {0, 1, 0}, {1, 1, 0},
		{-1, -1, 1}, {0, -1, 1}, {1, -1, 1}, {-1, 0, 1}, {0, 0, 1}, {1, 0, 1},
		{-1, 1, 1}, {0, 1, 1}, {1, 1, 1},
	}

	// TryteValueToTyteLUT is a lookup table to convert tryte values into trytes.
	TryteValueToTyteLUT = [TryteRadix]byte{'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
		'9', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M'}

	// TryteToTryteValueLUT is a lookup table to convert trytes into tryte values.
	TryteToTryteValueLUT = [...]int8{
		0, 0, 0, 0, 0, 0, 0, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13,
		-13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1,
	}

	// Pow27LUT is a Look-up-table for Decoding Trits to int64
	Pow27LUT = []int64{1,
		27,
		729,
		19683,
		531441,
		14348907,
		387420489,
		10460353203,
		282429536481,
		7625597484987,
		205891132094649,
		5559060566555523,
		150094635296999136,
		4052555153018976256}
)

Functions

func CanBeHash

func CanBeHash(trits Trits) bool

CanBeHash returns the validity of the trit length.

func CanTritsToTrytes

func CanTritsToTrytes(trits Trits) bool

CanTritsToTrytes returns true if t can be converted to trytes.

func MinTrits

func MinTrits(value int64) int

MinTrits returns the length of trits needed to encode the value.

func MustPutTryteTrits

func MustPutTryteTrits(trits []int8, v int8)

MustPutTryteTrits converts v in [-13,13] to its corresponding 3-trit value and writes this to trits. It panics on invalid input.

func MustTritsToTryteValue

func MustTritsToTryteValue(trits Trits) int8

MustTritsToTryteValue converts a slice of 3 into its corresponding value. It performs no validation on the provided inputs (therefore might return an invalid representation) and might panic.

func MustTryteToTryteValue

func MustTryteToTryteValue(t byte) int8

MustTryteToTryteValue converts a tryte char t in [9A-Z] to a tryte value in [-13,13]. Performs no validation on t (therefore might return an invalid representation) and might panic.

func MustTryteValueToTryte

func MustTryteValueToTryte(v int8) byte

MustTryteValueToTryte converts the value of a tryte v in [-13,13] to a tryte char in [9A-Z]. It panics when v is an invalid value.

func Sum

func Sum(a int8, b int8) int8

Sum returns the sum of two trits.

func TrailingZeros

func TrailingZeros(trits Trits) int

TrailingZeros returns the number of trailing zeros of the given trits.

func TritsEqual

func TritsEqual(a Trits, b Trits) (bool, error)

TritsEqual returns true if t and b are equal Trits.

func TritsToInt

func TritsToInt(t Trits) int64

TritsToInt converts a slice of trits into an integer and assumes little-endian notation.

func TrytesToInt

func TrytesToInt(t Trytes) int64

TrytesToInt converts a slice of trytes to int64.

func ValidTrit

func ValidTrit(t int8) bool

ValidTrit returns true if t is a valid trit.

func ValidTrits

func ValidTrits(trits Trits) error

ValidTrits returns true if t is valid trits (non-empty and -1, 0 or 1).

func ValidTryte

func ValidTryte(t rune) error

ValidTryte returns the validity of a tryte (must be rune A-Z or 9)

func ValidTrytes

func ValidTrytes(trytes Trytes) error

ValidTrytes returns true if t is made of valid trytes.

Types

type Hash

type Hash = Trytes

Hash represents a trinary hash

type Hashes

type Hashes = []Hash

Hashes is a slice of Hash.

type Trits

type Trits = []int8

Trits is a slice of int8. You should not use cast, use NewTrits instead to ensure the validity.

func AddTrits

func AddTrits(a Trits, b Trits) Trits

AddTrits adds a to b.

func IntToTrits

func IntToTrits(value int64, tritsCnt int) Trits

IntToTrits converts int64 to a slice of trits.

func MustPadTrits

func MustPadTrits(trits Trits, n int) Trits

MustPadTrits pads the given trits with 0 up to the given size. Performs no validation on the provided inputs (therefore might return an invalid representation) and might panic.

func MustTrytesToTrits

func MustTrytesToTrits(trytes Trytes) Trits

MustTrytesToTrits converts a slice of trytes into trits. Performs no validation on the provided inputs (therefore might return an invalid representation) and might panic.

func NewTrits

func NewTrits(t []int8) (Trits, error)

NewTrits casts Trits and checks its validity.

func PadTrits

func PadTrits(trits Trits, n int) (Trits, error)

PadTrits pads the given trits with 0 up to the given size.

func ReverseTrits

func ReverseTrits(trits Trits) Trits

ReverseTrits reverses the given trits.

func TrytesToTrits

func TrytesToTrits(trytes Trytes) (Trits, error)

TrytesToTrits converts a slice of trytes into trits.

type Trytes

type Trytes = string

Trytes is a string of trytes. Use NewTrytes() instead of typecasting.

func IntToTrytes

func IntToTrytes(value int64, trytesCnt int) Trytes

IntToTrytes converts int64 to a slice of trytes.

func MustPad

func MustPad(trytes Trytes, n int) Trytes

MustPad pads the given trytes with 9s up to the given size. Performs no validation on the provided inputs (therefore might return an invalid representation) and might panic.

func MustTritsToTrytes

func MustTritsToTrytes(trits Trits) Trytes

MustTritsToTrytes converts a slice of trits into trytes. Performs no validation on the input trits and might therefore return an invalid trytes representation (without a panic).

func NewTrytes

func NewTrytes(s string) (Trytes, error)

NewTrytes casts to Trytes and checks its validity.

func Pad

func Pad(trytes Trytes, n int) (Trytes, error)

Pad pads the given trytes with 9s up to the given size.

func TritsToTrytes

func TritsToTrytes(trits Trits) (Trytes, error)

TritsToTrytes converts a slice of trits into trytes. Returns an error if len(t)%3!=0