Skip to content

JuliaManifolds/AlgorithmsInterface.jl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧮 AlgorithmsInterface.jl

A small, composable interface for iterative algorithms in Julia.

docs CI runic codecov aqua

Design

Iterative methods tend to share the same moving parts, which can lead to quite a bit of boilerplate and friction when trying to compose them. This package aims to provide abstractions such as the main loop, stopping criteria, and a logging system shared by these methods. It does not ship any concrete algorithms; the goal is to provide the tools to build on. It does however ship with a useful set of stopping-criterion and logging primitives out of the box.

The surface is intentionally small. The main design goal of the interface is to cleanly separate the implementation of the algorithm itself from the generic tools that surround it. Those generic tools, such as stopping, logging and debugging, are written once and then work across every algorithm that adopts the interface.

See the documentation for the design walk-through, the API reference, and a worked example. For background and discussion, see the initial discussion.

Note that this package is still in its design phase, and while SemVer is respected, (breaking) changes might still occur as the design takes shape.

About

A small, composable interface for iterative algorithms in Julia

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages