29 releases
0.13.2 | Feb 24, 2024 |
---|---|
0.13.1 | Oct 20, 2023 |
0.12.0 | Sep 9, 2023 |
0.11.5 | Jan 4, 2023 |
0.3.0-alpha.1 | Jul 15, 2021 |
#392 in Rust patterns
21 downloads per month
Used in 2 crates
300KB
5K
SLoC
BellFrame
BellFrame is a standard library for change ringing.
In other words, BellFrame aims to provide high-quality idiomatic implementations of basic things
required for change ringing (e.g. borrowed/owned Row
types, place notation parsing, method
classification, access to the CC method library, etc.). These can then be shared between projects
to speed up development and reduce bugs.
The two fundamental goals of BellFrame are reliability and performance, in that order. Reliability means that BellFrame's behaviour is always well defined and never causes Undefined Behaviour, even for pathological inputs. Performance means, specifically, that BellFrame's code should never be the limiting factor in a project. However, reliability is more important than unbeatable performance; I'm not going write complex optimised code until I at least know that an operation is a bottleneck. It's just so much easier to maintain simple code.
Contents
Core Data-types:
Truth
,Parity
,Stroke
: Type-safe versions ofbool
, using the type system to prevent them from being mixed up.Stage
,Bell
: Type-safe representations, again for avoiding common errors like calling the treble1
(useful for humans) or0
(for indexing into arrays).Row
,RowBuf
: Borrowed and owned rows (respectively). Conceptually,Row
is like[Bell]
andRowBuf
is likeVec<Bell>
, except they are both guaranteed to contain valid permutations.
Methods
Method
,Call
: Method processing, and classification code. The classification algorithm is 100% compliant with the Framework (in implementing it, I discovered bugs in the CompLib's classifier, which have now been fixed).MethodLib
: Access to method libraries, withMethodLib::cc_lib()
loading an up-to-date copy of the Central Council's library. Searching the library is also supported, and also returns suggested method names for unsuccessful searches.
Block Manipulation:
SameStageVec
,Block
: Ways of storing sequences ofRow
s in a single contiguous chunk of memory (thus allowing huge cache-efficiency and optimisation potential).SameStageVec
is simply a sequence ofRow
s with the sameStage
;Block
allows itsRow
s to be given annotations of any type.
Other Useful Types:
Mask
: Like aRowBuf
, except that bells can be missing (denoted byx
). For example,1xxx5678
is aMask
, where 2,3,4 can go in any order.Pattern
: Default way of representing music patterns - like aMask
, except that*
matches any number of bells. For example,*x7x8x*
is aPattern
.
Dependencies
~2–17MB
~176K SLoC