ints

Documentation

Overview

Package ints provide manipulation of integer types.

Index

• Constants
• Variables
• func IntProperties[I constraints.Integer](variable ...I) (isSigned bool, maxPositive uint64, maxNegative int64, sizeof int)
• func Unsigned[U constraints.Unsigned, T constraints.Integer](integer T, label string) (unsigned U, err error)

Constants

const (
	BitsPerByte = 8
)

Variables

var ErrNegative = errors.New("negative value")

can be tested: errors.Is(err, ints.ErrNegative)

var ErrTooLarge = errors.New("value too large")

can be tested: errors.Is(err, ints.ErrToLarge)

Functions

func IntProperties

func IntProperties[I constraints.Integer](variable ...I) (isSigned bool, maxPositive uint64, maxNegative int64, sizeof int)

IntProperties returns the properties of integer I

• I is int int8 int16 int32 int64 uint uint8 uint16 uint32 uint64 uintptr
• isSigned is true if I is a signed integer type
• maxPositive is the largest positive number that can be assigned to I
• maxNegative is the largest negative number that can be assigned to I. For unsigned types, maxNegative is 0
• sizeof is the number of bytes I occupies: 1, 2, 4 or 8 for 8, 16, 32, 64-bit integers

func Unsigned

func Unsigned[U constraints.Unsigned, T constraints.Integer](integer T, label string) (unsigned U, err error)

Unsigned converts integer of type T to an unsigned value that fits the size of unsigned integer U

• U is the unsigned integer returned
• T is the input integer
• integer T is of any integer size and may be signed
• unsigned U is any size unsigned integer
• error: if integer is negative or too large to be held in type U