Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/JuliaArrays/ArrayInterface.jl

Designs for new Base array interface primitives, used widely through scientific machine learning (SciML) and other organizations
https://github.com/JuliaArrays/ArrayInterface.jl

arrays base composibility interface primitives scientific-machine-learning sciml

Last synced: 9 days ago
JSON representation

Designs for new Base array interface primitives, used widely through scientific machine learning (SciML) and other organizations

Host: GitHub
URL: https://github.com/JuliaArrays/ArrayInterface.jl
Owner: JuliaArrays
License: mit
Created: 2018-10-31T23:00:28.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2024-08-19T12:00:07.000Z (3 months ago)
Last Synced: 2024-08-19T13:51:13.438Z (3 months ago)
Topics: arrays, base, composibility, interface, primitives, scientific-machine-learning, sciml
Language: Julia
Homepage:
Size: 2.92 MB
Stars: 134
Watchers: 14
Forks: 36
Open Issues: 34
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.bib

Awesome Lists containing this project

awesome-sciml - JuliaArrays/ArrayInterface.jl: Designs for new Base array interface primitives, used widely through scientific machine learning (SciML) and other organizations

README

        # ArrayInterface.jl

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://docs.sciml.ai/ArrayInterface/stable/)

[![CI](https://github.com/JuliaArrays/ArrayInterface.jl/workflows/CI/badge.svg)](https://github.com/JuliaArrays/ArrayInterface.jl/actions?query=workflow%3ACI)

[![Build status](https://badge.buildkite.com/a2db252d92478e1d7196ee7454004efdfb6ab59496cbac91a2.svg?branch=master)](https://buildkite.com/julialang/arrayinterface-dot-jl)

[![codecov](https://codecov.io/gh/JuliaArrays/ArrayInterface.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaArrays/ArrayInterface.jl)

The AbstractArray interface in Base Julia is still relatively young.

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 are merged into Base Julia. For this

reason, no functionality is exported so that if such functions are added

and exported in a future Base Julia, there will be no issues with the upgrade.

# List of things to add

- https://github.com/JuliaLang/julia/issues/22216

- https://github.com/JuliaLang/julia/issues/22218

- https://github.com/JuliaLang/julia/issues/22622

- https://github.com/JuliaLang/julia/issues/25760

- https://github.com/JuliaLang/julia/issues/25107

# 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

## StaticArrayInterface.jl

If one is looking for an interface which includes functionality for statically-computed values, see [StaticArrayInterface.jl](https://github.com/JuliaArrays/StaticArrayInterface.jl).

This was separated from ArrayInterface.jl because it includes a lot of functionality that does not give substantive improvements

to the interface, and is likely to be deprecated in the near future as the compiler matures to automate a lot of its optimizations.

## Breaking Release Notes

7.0: Setup to use the new v1.9 package extensions. All static interface functions were moved to

[StaticArrayInterface.jl](https://github.com/JuliaArrays/StaticArrayInterface.jl). All packages

using one of the subpackages (ArrayInterfaceCore, ArrayInterfaceStaticArrays, etc.) should

update to v7 by simply depending on ArrayInterface.jl, unless static interface functions

were used in which case a dependency on StaticArrayInterface.jl is also necessary.

6.0: ArrayInterface.jl completely removed all usage of Requires.jl and conditional dependencies

due to compile time impact. All of the Requires.jl support changed to subpackages within the

repository which are registered in the General registry. These subpackages are required by

any packages which seek to use the additional functionality.

2.0: Changed the default of `ismutable(array::AbstractArray) = true`. We previously defaulted to

`Base.@pure ismutable(array::AbstractArray) = typeof(array).mutable`, but there are a lot of cases

where this tends to not work out in a way one would expect. For example, if you put a normal array

into an immutable struct that adds more information to it, this is considered immutable, even if

all of the `setindex!` methods work (by forwarding to the mutable array). Thus, it seems safer to just

always assume mutability is standard for an array, and allow arrays to opt-out.