From 8fab1e7db848862e4582e26a8ae4eb7ab5729144 Mon Sep 17 00:00:00 2001 From: Sambit Kumar Dash Date: Mon, 28 Aug 2017 14:35:59 +0530 Subject: [PATCH] Deleted build. --- docs/build/assets/arrow.svg | 63 ---- docs/build/assets/documenter.css | 541 ------------------------------- docs/build/assets/documenter.js | 129 -------- docs/build/assets/search.js | 91 ------ docs/build/index.html | 20 -- docs/build/search.html | 2 - docs/build/search_index.js | 179 ---------- 7 files changed, 1025 deletions(-) delete mode 100644 docs/build/assets/arrow.svg delete mode 100644 docs/build/assets/documenter.css delete mode 100644 docs/build/assets/documenter.js delete mode 100644 docs/build/assets/search.js delete mode 100644 docs/build/index.html delete mode 100644 docs/build/search.html delete mode 100644 docs/build/search_index.js diff --git a/docs/build/assets/arrow.svg b/docs/build/assets/arrow.svg deleted file mode 100644 index ee2798d..0000000 --- a/docs/build/assets/arrow.svg +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - diff --git a/docs/build/assets/documenter.css b/docs/build/assets/documenter.css deleted file mode 100644 index b8514ef..0000000 --- a/docs/build/assets/documenter.css +++ /dev/null @@ -1,541 +0,0 @@ -/* - * The default CSS style for Documenter.jl generated sites - * - * Heavily inspired by the Julia Sphinx theme - * https://github.com/JuliaLang/JuliaDoc - * which extends the sphinx_rtd_theme - * https://github.com/snide/sphinx_rtd_theme - * - * Part of Documenter.jl - * https://github.com/JuliaDocs/Documenter.jl - * - * License: MIT - */ - -/* fonts */ -body, input { - font-family: 'Lato', 'Helvetica Neue', Arial, sans-serif; - font-size: 16px; - color: #222; - text-rendering: optimizeLegibility; -} - -pre, code { - font-family: 'Roboto Mono', Monaco, courier, monospace; - font-size: 0.90em; -} - -pre code { - font-size: 1em; -} - -a { - color: #2980b9; - text-decoration: none; -} - -a:hover { - color: #3091d1; -} - -a:visited { - color: #9b59b6; -} - -body { - line-height: 1.5; -} - -h1 { font-size: 1.75em; } -h2 { font-size: 1.50em; } -h3 { font-size: 1.25em; } -h4 { font-size: 1.15em; } -h5 { font-size: 1.10em; } -h6 { font-size: 1em; } - -h4, h5, h6 { - margin: 1em 0; -} - -img { - max-width: 100%; -} - -table { - border-collapse: collapse; - margin: 1em 0; -} - -th, td { - border: 1px solid #e1e4e5; - padding: 0.5em 1em; -} - -th { - border-bottom-width: 2px; -} - -tr:nth-child(even) { - background-color: #f3f6f6; -} - -hr { - border: 0; - border-top: 1px solid #e5e5e5; -} - -/* Inline code and code blocks */ - -code { - padding: 0.1em; - background-color: rgba(0,0,0,.04); - border-radius: 3px; -} - -pre { - background-color: #f5f5f5; - border: 1px solid #dddddd; - border-radius: 3px; - padding: 0.5em; - overflow: auto; -} - -pre code { - padding: 0; - background-color: initial; -} - -/* Headers in admonitions and docstrings */ -.admonition h1, -article section.docstring h1 { - font-size: 1.25em; -} - -.admonition h2, -article section.docstring h2 { - font-size: 1.10em; -} - -.admonition h3, -.admonition h4, -.admonition h5, -.admonition h6, -article section.docstring h3, -article section.docstring h4, -article section.docstring h5, -article section.docstring h6 { - font-size: 1em; -} - -/* Navigation */ -nav.toc { - position: fixed; - top: 0; - left: 0; - bottom: 0; - width: 20em; - overflow-y: auto; - padding: 1em 0; - background-color: #fcfcfc; - box-shadow: inset -14px 0px 5px -12px rgb(210,210,210); -} - -nav.toc .logo { - margin: 0 auto; - display: block; - max-height: 6em; - max-width: 18em; -} - -nav.toc h1 { - text-align: center; - margin-top: .57em; - margin-bottom: 0; -} - -nav.toc select { - display: block; - height: 2em; - padding: 0 1.6em 0 1em; - min-width: 7em; - max-width: 90%; - max-width: calc(100% - 5em); - margin: 0 auto; - font-size: .83em; - border: 1px solid #c9c9c9; - border-radius: 1em; - - /* TODO: doesn't seem to be centered on Safari */ - text-align: center; - text-align-last: center; - - appearance: none; - -moz-appearance: none; - -webkit-appearance: none; - - background: white url("arrow.svg"); - background-size: 1.155em; - background-repeat: no-repeat; - background-position: right; -} - -nav.toc select:hover { - border: 1px solid #a0a0a0; -} - -nav.toc select option { - text-align: center; -} - -nav.toc input { - display: block; - height: 2em; - width: 90%; - width: calc(100% - 5em); - margin: 1.2em auto; - padding: 0 1em; - border: 1px solid #c9c9c9; - border-radius: 1em; - font-size: .83em; -} - -nav.toc > ul * { - margin: 0; -} - -nav.toc ul { - color: #404040; - padding: 0; - list-style: none; -} - -nav.toc ul .toctext { - color: inherit; - display: block; -} - -nav.toc ul a:hover { - color: #fcfcfc; - background-color: #4e4a4a; -} - -nav.toc ul.internal a { - color: inherit; - display: block; -} - -nav.toc ul.internal a:hover { - background-color: #d6d6d6; -} - -nav.toc ul.internal { - background-color: #e3e3e3; - box-shadow: inset -14px 0px 5px -12px rgb(210,210,210); - list-style: none; -} - -nav.toc ul.internal li.toplevel { - border-top: 1px solid #c9c9c9; - font-weight: bold; -} - -nav.toc ul.internal li.toplevel:first-child { - border-top: none; -} - -nav.toc .toctext { - padding-top: 0.3em; - padding-bottom: 0.3em; - padding-right: 1em; -} - -nav.toc ul .toctext { - padding-left: 1em; -} - -nav.toc ul ul .toctext { - padding-left: 2em; -} - -nav.toc ul ul ul .toctext { - padding-left: 3em; -} - -nav.toc li.current > .toctext { - border-top: 1px solid #c9c9c9; - border-bottom: 1px solid #c9c9c9; - color: #404040; - font-weight: bold; - background-color: white; -} - -article { - margin-left: 20em; - min-width: 20em; - max-width: 48em; - padding: 2em; -} - -article > header {} - -article > header div#topbar { - display: none; -} - -article > header nav ul { - display: inline-block; - list-style: none; - margin: 0; - padding: 0; -} - -article > header nav li { - display: inline-block; - padding-right: 0.2em; -} - -article > header nav li:before { - content: "»"; - padding-right: 0.2em; -} - -article > header .edit-page { - float: right; -} - -article > footer {} - -article > footer a.prev { - float: left; -} -article > footer a.next { - float: right; -} - -article > footer a .direction:after { - content: ": "; -} - -article hr { - margin: 1em 0; -} - -article section.docstring { - border: 1px solid #ddd; - margin: 0.5em 0; - padding: 0.5em; - border-radius: 3px; -} - -article section.docstring .docstring-header { - margin-bottom: 1em; -} - -article section.docstring .docstring-binding { - color: #333; - font-weight: bold; -} - -article section.docstring .docstring-category { - font-style: italic; -} - -article section.docstring a.source-link { - float: left; - font-weight: bold; -} - -.nav-anchor, -.nav-anchor:hover, -.nav-anchor:visited { - color: #333; -} - -/* - * Admonitions - * - * Colors (title, body) - * warning: #f0b37e #ffedcc (orange) - * note: #6ab0de #e7f2fa (blue) - * tip: #1abc9c #dbfaf4 (green) -*/ -.admonition { - border-radius: 3px; - background-color: #eeeeee; -} - -.admonition-title { - border-radius: 3px 3px 0 0; - background-color: #9b9b9b; - padding: 0.15em 0.5em; -} - -.admonition-text { - padding: 0.5em; -} - -.admonition-text > :first-child { - margin-top: 0; -} - -.admonition-text > :last-child { - margin-bottom: 0; -} - -.admonition > .admonition-title:before { - font-family: "FontAwesome"; - margin-right: 5px; - content: "\f06a"; -} - -.admonition.warning > .admonition-title { - background-color: #f0b37e; -} - -.admonition.warning { - background-color: #ffedcc; -} - -.admonition.note > .admonition-title { - background-color: #6ab0de; -} - -.admonition.note { - background-color: #e7f2fa; -} - -.admonition.tip > .admonition-title { - background-color: #1abc9c; -} - -.admonition.tip { - background-color: #dbfaf4; -} - - -/* footnotes */ -.footnote { - padding-left: 0.8em; - border-left: 2px solid #ccc; -} - -/* Search page */ -#search-results .category { - font-size: smaller; -} - -#search-results .category:before { - content: " "; -} - -/* Overriding the block style of highligh.js. - * We have to override the padding and the background-color, since we style this - * part ourselves. Specifically, we style the
 surrounding the , while
- * highlight.js applies the .hljs style directly to the  tag.
- */
-.hljs {
-    background-color: transparent;
-    padding: 0;
-}
-
-@media only screen and (max-width: 768px) {
-    nav.toc {
-        position: fixed;
-        overflow-y: scroll;
-        width: 16em;
-        left: -16em;
-        -webkit-overflow-scrolling: touch;
-        -webkit-transition-property: left; /* Safari */
-        -webkit-transition-duration: 0.3s; /* Safari */
-        transition-property: left;
-        transition-duration: 0.3s;
-        -webkit-transition-timing-function: ease-out; /* Safari */
-        transition-timing-function: ease-out;
-        z-index: 2;
-    }
-
-    nav.toc.show {
-        left: 0;
-    }
-
-    article {
-        margin-left: 0;
-        padding: 3em 0.9em 0 0.9em; /* top right bottom left */
-        overflow-wrap: break-word;
-    }
-
-    article > header {
-        position: fixed;
-        left: 0;
-        z-index: 1;
-    }
-
-    article > header nav, hr {
-        display: none;
-    }
-
-    article > header div#topbar {
-        display: block; /* is mobile */
-        position: fixed;
-        width: 100%;
-        height: 1.5em;
-        padding-top: 1em;
-        padding-bottom: 1em;
-        background-color: #fcfcfc;
-        box-shadow: 0 1px 3px rgba(0,0,0,.26);
-        top: 0;
-        -webkit-transition-property: top; /* Safari */
-        -webkit-transition-duration: 0.3s; /* Safari */
-        transition-property: top;
-        transition-duration: 0.3s;
-    }
-
-    article > header div#topbar.headroom--unpinned.headroom--not-top.headroom--not-bottom {
-        top: -4em;
-        -webkit-transition-property: top; /* Safari */
-        -webkit-transition-duration: 0.7s; /* Safari */
-        transition-property: top;
-        transition-duration: 0.7s;
-    }
-
-    article > header div#topbar span {
-        position: fixed;
-        width: 80%;
-        height: 1.5em;
-        margin-top: -0.1em;
-        margin-left: 0.9em;
-        font-size: 1.2em;
-        overflow: hidden;
-    }
-
-    article > header div#topbar a.fa-bars {
-        float: right;
-        padding: 0.6em;
-        margin-top: -0.6em;
-        margin-right: 0.3em;
-        font-size: 1.5em;
-    }
-
-    article > header div#topbar a.fa-bars:visited {
-        color: #3091d1;
-    }
-
-    article table {
-        overflow-x: auto;
-        display: block;
-    }
-
-    article div.MathJax_Display {
-        overflow: scroll;
-    }
-
-    article span.MathJax {
-        overflow: hidden;
-    }
-}
-
-@media only screen and (max-width: 320px) {
-    body {
-        font-size: 15px;
-    }
-}
diff --git a/docs/build/assets/documenter.js b/docs/build/assets/documenter.js
deleted file mode 100644
index 5d31622..0000000
--- a/docs/build/assets/documenter.js
+++ /dev/null
@@ -1,129 +0,0 @@
-/*
- * Part of Documenter.jl
- *     https://github.com/JuliaDocs/Documenter.jl
- *
- * License: MIT
- */
-
-requirejs.config({
-    paths: {
-        'jquery': 'https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.1/jquery.min',
-        'jqueryui': 'https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.12.0/jquery-ui.min',
-        'headroom': 'https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.3/headroom.min',
-        'mathjax': 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS_HTML',
-        'highlight': 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min',
-        'highlight-julia': 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/julia.min',
-        'highlight-julia-repl': 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/julia-repl.min',
-    },
-    shim: {
-        'mathjax' : {
-            exports: "MathJax"
-        },
-        'highlight-julia': ['highlight'],
-        'highlight-julia-repl': ['highlight'],
-    }
-});
-
-// Load MathJax
-require(['mathjax'], function(MathJax) {
-    MathJax.Hub.Config({
-      "tex2jax": {
-        inlineMath: [['$','$'], ['\\(','\\)']],
-        processEscapes: true
-      }
-    });
-    MathJax.Hub.Config({
-      config: ["MMLorHTML.js"],
-      jax: [
-        "input/TeX",
-        "output/HTML-CSS",
-        "output/NativeMML"
-      ],
-      extensions: [
-        "MathMenu.js",
-        "MathZoom.js",
-        "TeX/AMSmath.js",
-        "TeX/AMSsymbols.js",
-        "TeX/autobold.js",
-        "TeX/autoload-all.js"
-      ]
-    });
-    MathJax.Hub.Config({
-      TeX: { equationNumbers: { autoNumber: "AMS" } }
-    });
-})
-
-require(['jquery', 'highlight', 'highlight-julia', 'highlight-julia-repl'], function($, hljs) {
-    $(document).ready(function() {
-        hljs.initHighlighting();
-    })
-
-})
-
-// update the version selector with info from the siteinfo.js and ../versions.js files
-require(['jquery'], function($) {
-    $(document).ready(function() {
-        var version_selector = $("#version-selector");
-
-        // add the current version to the selector based on siteinfo.js, but only if the selector is empty
-        if (typeof DOCUMENTER_CURRENT_VERSION !== 'undefined' && $('#version-selector > option').length == 0) {
-            var option = $("");
-            version_selector.append(option);
-        }
-
-        if (typeof DOC_VERSIONS !== 'undefined') {
-            var existing_versions = $('#version-selector > option');
-            var existing_versions_texts = existing_versions.map(function(i,x){return x.text});
-            DOC_VERSIONS.forEach(function(each) {
-                var version_url = documenterBaseURL + "/../" + each;
-                var existing_id = $.inArray(each, existing_versions_texts);
-                // if not already in the version selector, add it as a new option,
-                // otherwise update the old option with the URL and enable it
-                if (existing_id == -1) {
-                    var option = $("");
-                    version_selector.append(option);
-                } else {
-                    var option = existing_versions[existing_id];
-                    option.value = version_url;
-                    option.disabled = false;
-                }
-            });
-        }
-
-        // only show the version selector if the selector has been populated
-        if ($('#version-selector > option').length > 0) {
-            version_selector.css("visibility", "visible");
-        }
-    })
-
-})
-
-// mobile
-require(['jquery', 'headroom'], function($, Headroom) {
-    $(document).ready(function() {
-        var navtoc = $("nav.toc");
-        $("nav.toc li.current a.toctext").click(function() {
-            navtoc.toggleClass('show');
-        });
-        $("article > header div#topbar a.fa-bars").click(function(ev) {
-            ev.preventDefault();
-            navtoc.toggleClass('show');
-            if (navtoc.hasClass('show')) {
-                var title = $("article > header div#topbar span").text();
-                $("nav.toc ul li a:contains('" + title + "')").focus();
-            }
-        });
-        $("article#docs").bind('click', function(ev) {
-            if ($(ev.target).is('div#topbar a.fa-bars')) {
-                return;
-            }
-            if (navtoc.hasClass('show')) {
-                navtoc.removeClass('show');
-            }
-        });
-        if ($("article > header div#topbar").css('display') == 'block') {
-            var headroom = new Headroom(document.querySelector("article > header div#topbar"), {"tolerance": {"up": 10, "down": 10}});
-            headroom.init();
-        }
-    })
-})
diff --git a/docs/build/assets/search.js b/docs/build/assets/search.js
deleted file mode 100644
index 4e3e9a4..0000000
--- a/docs/build/assets/search.js
+++ /dev/null
@@ -1,91 +0,0 @@
-/*
- * Part of Documenter.jl
- *     https://github.com/JuliaDocs/Documenter.jl
- *
- * License: MIT
- */
-
-// parseUri 1.2.2
-// (c) Steven Levithan 
-// MIT License
-function parseUri (str) {
-	var	o   = parseUri.options,
-		m   = o.parser[o.strictMode ? "strict" : "loose"].exec(str),
-		uri = {},
-		i   = 14;
-
-	while (i--) uri[o.key[i]] = m[i] || "";
-
-	uri[o.q.name] = {};
-	uri[o.key[12]].replace(o.q.parser, function ($0, $1, $2) {
-		if ($1) uri[o.q.name][$1] = $2;
-	});
-
-	return uri;
-};
-parseUri.options = {
-	strictMode: false,
-	key: ["source","protocol","authority","userInfo","user","password","host","port","relative","path","directory","file","query","anchor"],
-	q:   {
-		name:   "queryKey",
-		parser: /(?:^|&)([^&=]*)=?([^&]*)/g
-	},
-	parser: {
-		strict: /^(?:([^:\/?#]+):)?(?:\/\/((?:(([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?))?((((?:[^?#\/]*\/)*)([^?#]*))(?:\?([^#]*))?(?:#(.*))?)/,
-		loose:  /^(?:(?![^:@]+:[^:@\/]*@)([^:\/?#.]+):)?(?:\/\/)?((?:(([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?)(((\/(?:[^?#](?![^?#\/]*\.[^?#\/.]+(?:[?#]|$)))*\/?)?([^?#\/]*))(?:\?([^#]*))?(?:#(.*))?)/
-	}
-};
-
-requirejs.config({
-    paths: {
-        'jquery': 'https://code.jquery.com/jquery-3.1.0.js?',
-        'lunr': 'https://cdnjs.cloudflare.com/ajax/libs/lunr.js/0.7.1/lunr.min',
-    }
-});
-
-var currentScript = document.currentScript;
-
-require(["jquery", "lunr"], function($, lunr) {
-    var index = lunr(function () {
-        this.ref('location')
-        this.field('title', {boost: 10})
-        this.field('text')
-    })
-    var store = {}
-
-    documenterSearchIndex['docs'].forEach(function(e) {
-        index.add(e)
-        store[e.location] = e
-    })
-
-    $(function(){
-        function update_search(query) {
-            results = index.search(query)
-            $('#search-info').text("Number of results: " + results.length)
-            $('#search-results').empty()
-            results.forEach(function(result) {
-                data = store[result.ref]
-                link = $('')
-                link.text(data.title)
-                link.attr('href', documenterBaseURL+'/'+result.ref)
-                cat = $('('+data.category+')')
-                li = $('
  • ').append(link).append(cat) - $('#search-results').append(li) - }) - } - - function update_search_box() { - query = $('#search-query').val() - update_search(query) - } - - $('#search-query').keyup(update_search_box) - $('#search-query').change(update_search_box) - - search_query = parseUri(window.location).queryKey["q"] - if(search_query !== undefined) { - $("#search-query").val(search_query) - } - update_search_box(); - }) -}) diff --git a/docs/build/index.html b/docs/build/index.html deleted file mode 100644 index 950ce58..0000000 --- a/docs/build/index.html +++ /dev/null @@ -1,20 +0,0 @@ - -Numbers as Labels · LabelNumerals

    Numbers as Labels

    Numbers as Labels

    Numeric quantities are used sometimes for pure representational purposes without any true a 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 also have prefix notations as well. In some cases, the representation can be in upper case or lower case as well. This package implements such a numerals. Such numeric schemes are used as page numbers in PDF file specification. However, the need may be felt else where as well, which prompted the author to implement it as an independent package. The interface has been also influenced significantly by the RomanNumerals package.

    Usage

    LabelNumerals introduces the following new types:

    1. LetterNumeral - LabelNumeral{AlphaNumeral} - A, B, ..., Z, AA, BB, ..., ZZ, AAA... (group of 26 characters each)

    2. ArabicNumeral - LabelNumeral{Int} - 1, 2, 3, ...

    3. LookupNumeral - LabelNumeral{LookupNumeral} - mapped strings to integers like English words "One", "Two" etc.

    4. AlphaNumNumeral - LabelNumeral{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.

    !!Note: Letter, arabic and roman numerals are used in the PDF file pages as page number labels.

    LabelNumeral

        LabelNumeral{T<:Integer}

    Wrapper around an Integer type that provides the following caabilities:

    1. Prefix - like A-1, A-2 etc...

    2. Lower case or upper case conversions

    3. show and print options.

    4. Mathematical operators like +, -, <=, ==, >, isless, max and min

    The wrapped struct should implement the following methods:

    1. T(::String)
    -2. T(::Int)
    -3. Base.hash(::T)
    -4. Base.convert{S <: Integer}(::Type{S}, num::T)  <-- to covert to standard numeral types
    source
        LabelNumeral{T <: Integer}(::T; prefix="", caselower=false)
    -    LabelNumeral{T <: Integer}(::Type{T}, i::Integer; prefix="", caselower=false)
    -    LabelNumeral{T <: Integer}(::Type{T}, s::String; prefix="", caselower=false)

    Example:

    julia> using RomanNumerals
    -
    -julia> a = LabelNumeral(rn"XXIV"; prefix="A-", caselower=true)
    -A-xxiv
    -
    -julia> a = LabelNumeral(rn"XXIV"; prefix="A-")
    -A-XXIV

    Constructors for LabelNumeral

    source
        findLabels(label::String, ::Vector{DataType} = allNumerals; pfxList=Vector{String}=[""])
    -        -> Vector{Tuple{LabelNumeral,Type}}}

    Given allNumerals =[AlphaNumeral, RomanNumeral, Int, LookupNumeral, AlphaNumNumeral]

    Finds the LabelNumeral that is most suitably matching to the input String. pfxList provides one or more label prefix values.

    The function returns an array of all the matching LabelNumeral and the Type of numeral that best matches its internal composition.

    source

    AlphaNumeral

        AlphaNumeral

    Numbers represented as alphabets. ex. A, B, C,... from 27 onwards AA, BB, CC etc.

    source
        AlphaNumeral(str::String)
    -    AlphaNumeral(n::Int)

    Constructors for AlphaNumeral.

    source
        @an_str(str)

    String decorator for AlphaNumeral definitions.

    #Example

    julia> an"AA"
    -LabelNumerals.AlphaNumeral(27, "AA")
    source

    AlphaNumNumeral

        AlphaNumNumeral

    Numbers represented as alphabets as a base26 number where A, B, C represent digits. A = 0, B = 1, ..., Z = 25 etc.

    source
        AlphaNumNumeral(str::String)
    -    AlphaNumNumeral(n::Int)

    Constructors for AlphaNumNumeral.

    source
        @ann_str(str)

    String decorator for AlphaNumNumeral definitions.

    #Example

    julia> ann"BB"
    -LabelNumerals.AlphaNumNumeral(27, "BB")
    source

    LookupNumeral

        LookupNumeral

    Numbers represented as from a lookup table. No digits or additional system of extension possible. Only numbers available in the lookup table are valid.

    source
        LookupNumeral(str::String)
    -    LookupNumeral(n::Int)

    Constructors for LookupNumeral.

    source
        @ln_str(str)

    String decorator for LookupNumeral definitions.

    #Example

    julia> ln"Three"
    -LabelNumerals.LookupNumeral(3, "Three")
    source

    External Numeral Types

    ArabicNumeral

    Represented as Int types.

    RomanNumeral

    Represented as RomanNumeral from the RomanNumerals package.


    diff --git a/docs/build/search.html b/docs/build/search.html deleted file mode 100644 index a556df3..0000000 --- a/docs/build/search.html +++ /dev/null @@ -1,2 +0,0 @@ - -Search · LabelNumerals

    Search

    Search

    Number of results: loading...

      diff --git a/docs/build/search_index.js b/docs/build/search_index.js deleted file mode 100644 index 2fe9218..0000000 --- a/docs/build/search_index.js +++ /dev/null @@ -1,179 +0,0 @@ -var documenterSearchIndex = {"docs": [ - -{ - "location": "index.html#", - "page": "Numbers as Labels", - "title": "Numbers as Labels", - "category": "page", - "text": "" -}, - -{ - "location": "index.html#Numbers-as-Labels-1", - "page": "Numbers as Labels", - "title": "Numbers as Labels", - "category": "section", - "text": "Numeric quantities are used sometimes for pure representational purposes without any true a 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 also have prefix notations as well. In some cases, the representation can be in upper case or lower case as well. This package implements such a numerals. Such numeric schemes are used as page numbers in PDF file specification. However, the need may be felt else where as well, which prompted the author to implement it as an independent package. The interface has been also influenced significantly by the RomanNumerals package." -}, - -{ - "location": "index.html#Usage-1", - "page": "Numbers as Labels", - "title": "Usage", - "category": "section", - "text": "LabelNumerals introduces the following new types:LetterNumeral - LabelNumeral{AlphaNumeral} - A, B, ..., Z, AA, BB, ..., ZZ, AAA... (group of 26 characters each)\nArabicNumeral - LabelNumeral{Int} - 1, 2, 3, ...\nLookupNumeral - LabelNumeral{LookupNumeral} - mapped strings to integers like English words \"One\", \"Two\" etc.\nAlphaNumNumeral - LabelNumeral{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.!!Note: Letter, arabic and roman numerals are used in the PDF file pages as page number labels." -}, - -{ - "location": "index.html#LabelNumerals.LabelNumeral", - "page": "Numbers as Labels", - "title": "LabelNumerals.LabelNumeral", - "category": "Type", - "text": " LabelNumeral{T<:Integer}\n\nWrapper around an Integer type that provides the following caabilities:\n\nPrefix - like A-1, A-2 etc...\nLower case or upper case conversions\nshow and print options.\nMathematical operators like +, -, <=, ==, >, isless, max and min\n\nThe wrapped struct should implement the following methods:\n\n1. T(::String)\n2. T(::Int)\n3. Base.hash(::T)\n4. Base.convert{S <: Integer}(::Type{S}, num::T) <-- to covert to standard numeral types\n\n\n\n" -}, - -{ - "location": "index.html#LabelNumerals.LabelNumeral-Union{Tuple{T}, Tuple{T}} where T<:Integer", - "page": "Numbers as Labels", - "title": "LabelNumerals.LabelNumeral", - "category": "Method", - "text": " LabelNumeral{T <: Integer}(::T; prefix=\"\", caselower=false)\n LabelNumeral{T <: Integer}(::Type{T}, i::Integer; prefix=\"\", caselower=false)\n LabelNumeral{T <: Integer}(::Type{T}, s::String; prefix=\"\", caselower=false)\n\nExample:\n\njulia> using RomanNumerals\n\njulia> a = LabelNumeral(rn\"XXIV\"; prefix=\"A-\", caselower=true)\nA-xxiv\n\njulia> a = LabelNumeral(rn\"XXIV\"; prefix=\"A-\")\nA-XXIV\n\nConstructors for LabelNumeral\n\n\n\n" -}, - -{ - "location": "index.html#LabelNumerals.findLabels", - "page": "Numbers as Labels", - "title": "LabelNumerals.findLabels", - "category": "Function", - "text": " findLabels(label::String, ::Vector{DataType} = allNumerals; pfxList=Vector{String}=[\"\"])\n -> Vector{Tuple{LabelNumeral,Type}}}\n\nGiven allNumerals =[AlphaNumeral, RomanNumeral, Int, LookupNumeral, AlphaNumNumeral]\n\nFinds the LabelNumeral that is most suitably matching to the input String. pfxList provides one or more label prefix values.\n\nThe function returns an array of all the matching LabelNumeral and the Type of numeral that best matches its internal composition. \n\n\n\n" -}, - -{ - "location": "index.html#LabelNumeral-1", - "page": "Numbers as Labels", - "title": "LabelNumeral", - "category": "section", - "text": "LabelNumeral{T <: Integer}\nLabelNumeral{T <: Integer}(t::T; prefix=\"\", caselower=false)\nfindLabels" -}, - -{ - "location": "index.html#LabelNumerals.AlphaNumeral", - "page": "Numbers as Labels", - "title": "LabelNumerals.AlphaNumeral", - "category": "Type", - "text": " AlphaNumeral\n\nNumbers represented as alphabets. ex. A, B, C,... from 27 onwards AA, BB, CC etc.\n\n\n\n" -}, - -{ - "location": "index.html#LabelNumerals.AlphaNumeral-Tuple{String}", - "page": "Numbers as Labels", - "title": "LabelNumerals.AlphaNumeral", - "category": "Method", - "text": " AlphaNumeral(str::String)\n AlphaNumeral(n::Int)\n\nConstructors for AlphaNumeral.\n\n\n\n" -}, - -{ - "location": "index.html#LabelNumerals.@an_str", - "page": "Numbers as Labels", - "title": "LabelNumerals.@an_str", - "category": "Macro", - "text": " @an_str(str)\n\nString decorator for AlphaNumeral definitions.\n\n#Example\n\njulia> an\"AA\"\nLabelNumerals.AlphaNumeral(27, \"AA\")\n\n\n\n" -}, - -{ - "location": "index.html#AlphaNumeral-1", - "page": "Numbers as Labels", - "title": "AlphaNumeral", - "category": "section", - "text": "AlphaNumeral\nAlphaNumeral(::String)\n@an_str" -}, - -{ - "location": "index.html#LabelNumerals.AlphaNumNumeral", - "page": "Numbers as Labels", - "title": "LabelNumerals.AlphaNumNumeral", - "category": "Type", - "text": " AlphaNumNumeral\n\nNumbers represented as alphabets as a base26 number where A, B, C represent digits. A = 0, B = 1, ..., Z = 25 etc.\n\n\n\n" -}, - -{ - "location": "index.html#LabelNumerals.AlphaNumNumeral-Tuple{String}", - "page": "Numbers as Labels", - "title": "LabelNumerals.AlphaNumNumeral", - "category": "Method", - "text": " AlphaNumNumeral(str::String)\n AlphaNumNumeral(n::Int)\n\nConstructors for AlphaNumNumeral.\n\n\n\n" -}, - -{ - "location": "index.html#LabelNumerals.@ann_str", - "page": "Numbers as Labels", - "title": "LabelNumerals.@ann_str", - "category": "Macro", - "text": " @ann_str(str)\n\nString decorator for AlphaNumNumeral definitions.\n\n#Example\n\njulia> ann\"BB\"\nLabelNumerals.AlphaNumNumeral(27, \"BB\")\n\n\n\n" -}, - -{ - "location": "index.html#AlphaNumNumeral-1", - "page": "Numbers as Labels", - "title": "AlphaNumNumeral", - "category": "section", - "text": "AlphaNumNumeral\nAlphaNumNumeral(::String)\n@ann_str" -}, - -{ - "location": "index.html#LabelNumerals.LookupNumeral", - "page": "Numbers as Labels", - "title": "LabelNumerals.LookupNumeral", - "category": "Type", - "text": " LookupNumeral\n\nNumbers represented as from a lookup table. No digits or additional system of extension possible. Only numbers available in the lookup table are valid.\n\n\n\n" -}, - -{ - "location": "index.html#LabelNumerals.LookupNumeral-Tuple{String}", - "page": "Numbers as Labels", - "title": "LabelNumerals.LookupNumeral", - "category": "Method", - "text": " LookupNumeral(str::String)\n LookupNumeral(n::Int)\n\nConstructors for LookupNumeral.\n\n\n\n" -}, - -{ - "location": "index.html#LabelNumerals.@ln_str", - "page": "Numbers as Labels", - "title": "LabelNumerals.@ln_str", - "category": "Macro", - "text": " @ln_str(str)\n\nString decorator for LookupNumeral definitions.\n\n#Example\n\njulia> ln\"Three\"\nLabelNumerals.LookupNumeral(3, \"Three\")\n\n\n\n" -}, - -{ - "location": "index.html#LookupNumeral-1", - "page": "Numbers as Labels", - "title": "LookupNumeral", - "category": "section", - "text": "LookupNumeral\nLookupNumeral(::String)\n@ln_str" -}, - -{ - "location": "index.html#External-Numeral-Types-1", - "page": "Numbers as Labels", - "title": "External Numeral Types", - "category": "section", - "text": "" -}, - -{ - "location": "index.html#ArabicNumeral-1", - "page": "Numbers as Labels", - "title": "ArabicNumeral", - "category": "section", - "text": "Represented as Int types." -}, - -{ - "location": "index.html#RomanNumeral-1", - "page": "Numbers as Labels", - "title": "RomanNumeral", - "category": "section", - "text": "Represented as RomanNumeral from the RomanNumerals package." -}, - -]}