Application Programming Interface for ArrayAllocators.ByteCalculators

ArrayAllocators.ByteCalculators

Defines calculators for computing the number of bytes needed to allocate an array while detecting integer overflow.

Examples

using ArrayAllocators.ByteCalculators

bc = CheckedMulByteCalculator{UInt8}(1024, 2048)
elsize(bc)
nbytes(bc)

CheckedMulByteCalculator

Calculate the number of bytes by using Base.checked_mul to check if the product of the dimensions (length) or the product of the length and the element size will cause an integer overflow.

WideningByteCalculator

Widens eltype(Dims), Int in order to catch integer overflow.

UnsafeByteCalculator

Calculate number of bytes to allocate for an array without any integer overflow checking.

SafeByteCalculators

Extension of ArrayAllocators.ByteCalculators using SaferIntegers.jl.

SafeByteCalculator

Use SafeInt from SaferIntegers.jl to calculate the number of bytes to allocate for an Array.

AbstractByteCalculator

Parent abstract type for byte calculators, which calculate the total number of bytes of memory to allocate.