rational

README

Rational

Utilties for rational number calculation, parsing and manipulation for Golang.

Inspired by (ported from) original ffmpeg/libav AVRational struct.

Documentation

Index

• Variables
• type Rational
  • func NewRational(v string) (Rational, error)
  • func (r Rational) Float64() float64
  • func (r Rational) IsNil() bool
  • func (r Rational) MarshalJSON() ([]byte, error)
  • func (r Rational) MarshalYAML() (interface{}, error)
  • func (r Rational) Percent() float64
  • func (r Rational) Reverse() Rational
  • func (r Rational) String() string
  • func (r Rational) StringAlt() string
  • func (r Rational) StringAlt2() string
  • func (r *Rational) Unmarshal(fn func(interface{}) error) error
  • func (r *Rational) UnmarshalJSON(data []byte) error
  • func (r *Rational) UnmarshalYAML(unmarshal func(interface{}) error) error

Variables

var (
	// Rational0 represents Nil Rational.
	Rational0 = Rational{0, 0}

	// Rational100 represents completed Rational.
	Rational100 = Rational{100, 100}
)

var (
	// ErrWrongPartsNumber indicates parsing error
	// because of wrong parts number in raw string.
	ErrWrongPartsNumber error = errors.New("got wrong string parts number")

	// ErrParseNum indicates parsing numerator error.
	ErrParseNum error = errors.New("failed parse numerator")

	// ErrParseDen indicates parsing denumerator error.
	ErrParseDen error = errors.New("failed parse denumerator")
)

Types

type Rational

type Rational struct {
	Num uint64 `json:"num" yaml:"num" bson:"num"`
	Den uint64 `json:"den" yaml:"den" bson:"den"`
}

Rational number numerator/denominator.

func NewRational

func NewRational(v string) (Rational, error)

NewRational parses raw string and returns Rational.

func (Rational) Float64

func (r Rational) Float64() float64

Float64 returns float64 representation.

func (Rational) IsNil

func (r Rational) IsNil() bool

IsNil checks if Rational is nil.

func (Rational) MarshalJSON

func (r Rational) MarshalJSON() ([]byte, error)

MarshalJSON implements json Marshaler.

func (Rational) MarshalYAML

func (r Rational) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml Marshaler.

func (Rational) Percent

func (r Rational) Percent() float64

Percent returns percentage representation. e.g. 1/4 is 25%.

func (Rational) Reverse

func (r Rational) Reverse() Rational

Reverse returns reversed Rational.

func (Rational) String

func (r Rational) String() string

String returns string representation.

func (Rational) StringAlt

func (r Rational) StringAlt() string

String returns string representation with sepAlt.

func (Rational) StringAlt2

func (r Rational) StringAlt2() string

String returns string representation with sepAlt.

func (*Rational) Unmarshal

func (r *Rational) Unmarshal(fn func(interface{}) error) error

Unmarshal is generic Unmarshaler. For example to use with GetBSON.

func (*Rational) UnmarshalJSON

func (r *Rational) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json Unmarshaler.

func (*Rational) UnmarshalYAML

func (r *Rational) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml Unmarshaler.