ArrayInterface.jl

Julia has only recently reached v1.0 and the AbstractArray interface is still quite new. The purpose of this library is to solidify extensions to the current AbstractArray interface which are put to use in package ecosystems like DifferentialEquations.jl. Since these libraries are live, this package will serve as a staging ground for ideas before they merged into Base Julia. For this reason, no functionality is exported so that way if such functions are added and exported in a future Base Julia there will be no issues with the upgrade.

ismutable(x)

A trait function for whether x is a mutable or immutable array. Used for dispatching to in-place and out-of-place versions of functions.

isstructured(x)

A trait function for whether a matrix x is a sparse structured matrix.

can_setindex(x)

A trait function for whether an array x can use setindex!

has_sparsestruct(x)

Determine whether findstructralnz accepts the parameter x

findstructralnz(x)

Returns iterators (I,J) of the non-zeros in the structure of the matrix x. The same as the to first two elements of findnz(::SparseMatrixCSC)

fast_matrix_colors(A)

A trait function for whether matrix_colors(A) is a fast algorithm or a slow (graphically-based) method.

matrix_colors(A)

Returns an array of for the sparsity colors of a matrix type A. Also includes an abstract type ColoringAlgorithm for matrix_colors(A,alg::ColoringAlgorithm) of non-structured matrices.

fast_scalar_indexing(A)

A trait function for whether scalar indexing is fast on a given array type.

allowed_getindex(A,i...)

A getindex which is always allowed.

allowed_setindex!(A,v,i...)

A setindex! which is always allowed.

List of things to add

Array Types to Handle

The following common array types are being understood and tested as part of this development.

Array
Various versions of sparse arrays
SArray
MArray
FieldVector
ArrayPartition
VectorOfArray
DistributedArrays
GPUArrays (CLArrays and CuArrays)
AFArrays
MultiScaleArrays
LabelledArrays

Name	Latest commit message	Commit time
Failed to load latest commit information.
src	Default to ismutable(array) = true	Nov 15, 2019
test	Fix ismutable for sparse arrays	Nov 14, 2019
.gitignore	move to Project.toml	Jul 27, 2019
.travis.yml	Create .travis.yml	Nov 1, 2018
CITATION.bib	Add journal to CITATION.bib	Jun 24, 2019
LICENSE	Initial commit	Oct 31, 2018
Project.toml	Update Project.toml	Nov 15, 2019
README.md	documented allowed get and set	Jul 30, 2019
appveyor.yml	Update appveyor.yml	Nov 1, 2018

JuliaDiffEq/ArrayInterface.jl

Join GitHub today

Clone with HTTPS

Downloading...

Launching GitHub Desktop...