GitHub

Reference

Index

Public API

FixedSizeArrays.FixedSizeArray — Type
FixedSizeArray{T,N,Mem<:DenseVector{T}}(undef, size::NTuple{N,Int})
FixedSizeArray{T,N,Mem<:DenseVector{T}}(undef, size1::Int, size2::Int, ...)
FixedSizeArray{T,N,Mem<:DenseVector{T}}(array::AbstractArray)

Construct a fixed-size FixedSizeArray with element type T, number of dimensions N, and memory backend Mem.

Convenient aliases provided:

source
FixedSizeArrays.FixedSizeVector — Type
FixedSizeVector{T,Mem<:DenseVector{T}}(undef, size::NTuple{1,Int})
FixedSizeVector{T,Mem<:DenseVector{T}}(undef, size1::Int)
FixedSizeVector{T,Mem<:DenseVector{T}}(array::AbstractVector)

Construct a fixed-size 1-dimensional FixedSizeArray with element type T, and memory backend Mem.

Convenient aliases provided:

source
FixedSizeArrays.FixedSizeMatrix — Type
FixedSizeMatrix{T,Mem<:DenseMatrix{T}}(undef, size::NTuple{2,Int})
FixedSizeMatrix{T,Mem<:DenseMatrix{T}}(undef, size1::Int, size2::Int)
FixedSizeMatrix{T,Mem<:DenseMatrix{T}}(array::AbstractMatrix)

Construct a fixed-size 2-dimensional FixedSizeArray with element type T, and memory backend Mem.

Convenient aliases provided:

source
FixedSizeArrays.FixedSizeArrayDefault — Type
FixedSizeArrayDefault{T,N}(undef, size::NTuple{N,Int})
FixedSizeArrayDefault{T,N}(undef, size1::Int, size2::Int, ...)
FixedSizeArrayDefault{T,N}(array::AbstractArray)

Construct a FixedSizeArray with element type T, number of dimensions N, and the default memory backend (Vector{T} on Julia v1.10, Memory{T} on Julia v1.11+).

source
FixedSizeArrays.FixedSizeVectorDefault — Type
FixedSizeVectorDefault{T}(undef, size::NTuple{1,Int})
FixedSizeVectorDefault{T}(undef, size1::Int)
FixedSizeVectorDefault{T}(array::AbstractVector)

Construct a FixedSizeVector with element type T, and the default memory backend (Vector{T} on Julia v1.10, Memory{T} on Julia v1.11+).

source
FixedSizeArrays.FixedSizeMatrixDefault — Type
FixedSizeMatrixDefault{T}(undef, size::NTuple{2,Int})
FixedSizeMatrixDefault{T}(undef, size1::Int, size2::Int)
FixedSizeMatrixDefault{T}(array::AbstractMatrix)

Construct a FixedSizeMatrix with element type T, and the default memory backend (Vector{T} on Julia v1.10, Memory{T} on Julia v1.11+).

source
Base.parent — Function
parent(f::FixedSizeArray)

Return the underlying parent object of the fixed-size array f. Use parentindices(f) to get the valid indices of the parent of f.

source
FixedSizeArrays.BoundsErrorLight — Type
BoundsErrorLight <: Exception

Like BoundsError, but doesn't store the array, to prevent clashing with escape analysis.

Stores the type of the array and the shape instead.

source

Internal API

This section gathers documentation of internal functionalities of FixedSizeArrays.jl which are only of interest to the developers of and contributors to this package.

Warning

The following functionalities are not part of the public API of the package and should not be relied upon by external packages, as they can be modified or removed at any point without notice.

FixedSizeArrays.with_stripped_type_parameters — Function
with_stripped_type_parameters(spec, t::Type)::Val{s}

The type s is a UnionAll supertype of t:

(s isa UnionAll) && (t <: s)

Furthermore, s has type variables in place of the type parameters specified via spec.

NB: Val{s}() is returned instead of s so the method would be consistent from the point of view of Julia's effect inference, enabling constant folding.

NB: this function is supposed to only have the one method. To add functionality, add methods to with_stripped_type_parameters_unchecked.

source