Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.81 KB

README.md

File metadata and controls

41 lines (28 loc) · 1.81 KB

LabelNumerals

GitHub Action Coverage Status codecov.io

Dev Documentation

Sometimes, we use numeric quantities for pure representational purposes without any true numeric significance. For example, the page numbering is carried out using simple Arabic numerals, roman numerals, alphabets. These numbers have additive properties but may not have any multiplicative significance. Such numbers can have prefix notations as well. In some cases, the representation can be in upper case or lower case as well. This package implements such numerals. The interface has a similar interface as the RomanNumerals package.

Usage

LabelNumerals introduces the following new types:

  1. LetterNumeral - A, B, ..., Z, AA, BB, ..., ZZ, AAA... (group of 26 characters each)
  2. ArabicNumeral - 1, 2, 3, ...
  3. LookupNumeral - Mapped strings to integers like English words "One", "Two" etc.
  4. AlphaNumNumeral - Alphabets representing numbers like BA, BB, BC etc.

It also supports RomanNumeral from RomanNumerals package.

They support ability to provide a string prefix. The prefix does not get incremented as numbers are incremented.

Examples

TBD

Features

TBD

Contributing

Pull requests adding functionality are welcome.