fixedpoint

Documentation

Overview

Package fixedpoint provides constants, as well as formatting, conversion, and checking functionality for Cadence fixed-point number types

Index

• Constants
• Variables
• func CheckRange(negative bool, ...) bool
• func ConvertToFixedPointBigInt(negative bool, unsignedInteger *big.Int, fractional *big.Int, scale uint, ...) *big.Int
• func NewFix64(negative bool, unsignedInteger *big.Int, fractional *big.Int, parsedScale uint) (*big.Int, error)
• func NewUFix64(unsignedInteger *big.Int, fractional *big.Int, parsedScale uint) (*big.Int, error)
• func ParseFix64(s string) (*big.Int, error)
• func ParseUFix64(s string) (*big.Int, error)

Constants

const Fix64Factor = 100_000_000

const Fix64Scale = 8

const Fix64TypeMaxFractional = math.MaxInt64 % Fix64Factor

const Fix64TypeMaxInt = math.MaxInt64 / Fix64Factor

const Fix64TypeMinFractional = math.MinInt64 % Fix64Factor

const Fix64TypeMinInt = math.MinInt64 / Fix64Factor

const UFix64TypeMaxFractional = math.MaxUint64 % uint64(Fix64Factor)

const UFix64TypeMaxInt = math.MaxUint64 / uint64(Fix64Factor)

const UFix64TypeMinFractional = 0

const UFix64TypeMinInt = 0

Variables

var Fix64TypeMaxFractionalBig = new(big.Int).SetInt64(Fix64TypeMaxFractional)

var Fix64TypeMaxIntBig = new(big.Int).SetInt64(Fix64TypeMaxInt)

var Fix64TypeMinFractionalBig = new(big.Int).SetInt64(Fix64TypeMinFractional)

var Fix64TypeMinIntBig = new(big.Int).SetInt64(Fix64TypeMinInt)

var UFix64TypeMaxFractionalBig = new(big.Int).SetUint64(UFix64TypeMaxFractional)

var UFix64TypeMaxIntBig = new(big.Int).SetUint64(UFix64TypeMaxInt)

var UFix64TypeMinFractionalBig = new(big.Int).SetUint64(UFix64TypeMinFractional)

var UFix64TypeMinIntBig = new(big.Int).SetUint64(UFix64TypeMinInt)

Functions

func CheckRange

func CheckRange(
	negative bool,
	unsignedIntegerValue, fractionalValue,
	minInt, minFractional,
	maxInt, maxFractional *big.Int,
) bool

func ConvertToFixedPointBigInt

func ConvertToFixedPointBigInt(
	negative bool,
	unsignedInteger *big.Int,
	fractional *big.Int,
	scale uint,
	targetScale uint,
) *big.Int

func NewFix64

func NewFix64(
	negative bool,
	unsignedInteger *big.Int,
	fractional *big.Int,
	parsedScale uint,
) (
	*big.Int,
	error,
)

func NewUFix64

func NewUFix64(
	unsignedInteger *big.Int,
	fractional *big.Int,
	parsedScale uint,
) (
	*big.Int,
	error,
)

func ParseFix64

func ParseFix64(s string) (*big.Int, error)

func ParseUFix64

func ParseUFix64(s string) (*big.Int, error)