plurimath 0.1.0 → 0.2.1

data/MathML-Supported-Data.adoc

@@ -0,0 +1,270 @@
+=== MathML Support
+
+==== Classes
+|===
+| Functions | Fonts
+
+| stackrel  | double-struck
+| underset  | sans-serif
+| mathfrak  | monospace
+| mathcal   | fraktur
+| overset   | script
+| cancel    | bold
+| obrace    | 
+| ubrace    | 
+| mathtt    | 
+| mathbf    | 
+| mathbb    | 
+| mathsf    | 
+| arctan    | 
+| arcsin    | 
+| arccos    | 
+| color     | 
+| floor     | 
+| tilde     | 
+| prod      | 
+| text      | 
+| norm      | 
+| sqrt      | 
+| cosh      | 
+| tanh      | 
+| sinh      | 
+| sech      | 
+| csch      | 
+| coth      | 
+| ddot      | 
+| ceil      | 
+| oint      | 
+| root      | 
+| frac      | 
+| log       | 
+| mod       | 
+| vec       | 
+| hat       | 
+| dot       | 
+| bar       | 
+| abs       | 
+| min       | 
+| max       | 
+| dim       | 
+| det       | 
+| csc       | 
+| cot       | 
+| lub       | 
+| lcm       | 
+| glb       | 
+| gcd       | 
+| exp       | 
+| sum       | 
+| cos       | 
+| tan       | 
+| sin       | 
+| int       | 
+| sec       | 
+| ln        | 
+| ul        | 
+| g         | 
+| f         |
+|===
+
+==== Tags
+** annotation_xml
+** annotation-xml
+** mmultiscripts
+** maligngroup
+** munderover
+** annotation
+** malignmark
+** semantics
+** mscarries
+** menclose
+** mlongdiv
+** mphantom
+** mfenced
+** msgroup
+** maction
+** mpadded
+** msubsup
+** mscarry
+** msline
+** mspace
+** mstack
+** mstyle
+** mtable
+** munder
+** merror
+** msqrt
+** mroot
+** msrow
+** mover
+** mfrac
+** math
+** mrow
+** msub
+** msup
+** mtd
+** mtr
+** mn
+** mo
+** mi
+** ms
+
+==== Unicodes
+** \α
+** \β
+** \γ
+** \Γ
+** \δ
+** \Δ
+** \∆
+** \ε
+** \ɛ
+** \ζ
+** \η
+** \θ
+** \Θ
+** \ϑ
+** \ι
+** \κ
+** \λ
+** \Λ
+** \μ
+** \ν
+** \ξ
+** \Ξ
+** \π
+** \Π
+** \ρ
+** \ς
+** \σ
+** \Σ
+** \τ
+** \υ
+** \φ
+** \Φ
+** \ϕ
+** \χ
+** \ψ
+** \Ψ
+** \ω
+** \Ω
+** \⋅
+** \∙
+** \·
+** \∗
+** \⋆
+** \×
+** \⋉
+** \⋊
+** \⋈
+** \÷
+** \∘
+** \⊕
+** \⨁
+** \⊗
+** \⊙
+** \∑
+** \∏
+** \∏
+** \∧
+** \⋀
+** \∨
+** \⋁
+** \∩
+** \⋂
+** \∪
+** \⋃
+** \≠
+** \≤
+** \≥
+** \≺
+** \≻
+** \⪯
+** \⪰
+** \∈
+** \∉
+** \⊂
+** \⊃
+** \⊆
+** \⊇
+** \≡
+** \≅
+** \≈
+** \∝
+** \¬
+** \∀
+** \∃
+** \⊥
+** \⊤
+** \⊢
+** \⊨
+** \〈
+** \〉
+** \⟨
+** \⟩
+** \∫
+** \∮
+** \∂
+** \∇
+** \±
+** \∅
+** \∞
+** \ℵ
+** \∴
+** \∵
+** \∠
+** \△
+** \′
+** \  
+** \    
+** \⌢
+** \⋯
+** \⋮
+** \⋱
+** \⋄
+** \□
+** \⌊
+** \⌋
+** \⌈
+** \⌉
+** \ℂ
+** \ℕ
+** \ℚ
+** \ℝ
+** \ℤ
+** \↑
+** \↓
+** \←
+** \↔
+** \⇒
+** \⇐
+** \⇔
+** \→
+** \↣
+** \↠
+** \⤖
+** \↦
+** \…
+** \−
+** \⁡
+** \⏞
+** \⏟
+
+=== Symbols
+** |
+** /
+** \
+** ~
+** (
+** )
+** (:
+** :)
+** {
+** }
+** {:
+** :}
+** ]
+** [
+** =
+** +
+** -

data/README.adoc

@@ -0,0 +1,94 @@
+= Plurimath
+
+This gem implements a mechanism of conversion between Math languages mentioned below.
+
+1. **AsciiMath**
+2. **MathML** 
+3. **Latex** 
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "plurimath"
+```
+And then execute:
+```shell
+
+    $ bundle install
+```
+Or install it yourself as:
+```shell
+    $ gem install plurimath
+```
+
+== Usage
+
+Pass the string you want to convert and Math type of the string provided, which will give you **Plurimath::Math::Formula** object as output, Let's see some examples below.
+
+=== Conversion Examples
+
+==== Asciimath Formula Example
+[source, ruby]
+----
+asciimath = "sin(1)"
+formula = Plurimath::Math.parse(asciimath, :asciimath)
+----
+==== MathML Formula Example
+[source, ruby]
+----
+mathml = <<~MATHML
+              <math xmlns='http://www.w3.org/1998/Math/MathML'>
+                <mstyle displaystyle='true'>
+                  <mi>sin</mi>
+                  <mn>1</mn>
+                </mstyle>
+              </math>
+            MATHML
+formula = Plurimath::Math.parse(mathml, "mathml")
+----
+==== Latex Formula Example
+[source, ruby]
+----
+latex = "\\sin{1}"
+formula = Plurimath::Math.parse(latex, "latex")
+----
+---
+Since we have the object of **Plurimath::Formula**,We can generate **AsciiMath**, **MathMl** or **Latex** string from the formula object,All we have to do is call conversion function on formula object, see examples below.
+
+==== AsciiMath Output conversion
+[source, ruby]
+----
+formula.to_asciimath
+> sin(1)
+----
+==== Latex Output conversion
+[source, ruby]
+----
+formula.to_latex
+> \\sin1
+----
+==== MathML Output conversion
+[source, ruby]
+----
+formula.to_mathml
+> <math xmlns='http://www.w3.org/1998/Math/MathML'>
+>   <mstyle displaystyle='true'>
+>     <mi>sin</mi>
+>     <mn>1</mn>
+>   </mstyle>
+> </math>
+----
+=== Supported Content
+--
+include::AsciiMath-Supported-Data.adoc[]
+--
+
+--
+include::MathML-Supported-Data.adoc[]
+--
+
+--
+include::Latex-Supported-Data.adoc[]
+--

data/lib/plurimath/asciimath/constants.rb

@@ -0,0 +1,301 @@
+# frozen_string_literal: true
+
+module Plurimath
+  class Asciimath
+    class Constants
+      TABLE_PARENTHESIS = {
+        "[": "]",
+        "{": "}",
+        "(": ")",
+        "|": "|",
+      }.freeze
+      PARENTHESIS = {
+        "(:": ":)",
+        "{:": ":}",
+        "(": ")",
+        "{": "}",
+        "[": "]",
+      }.freeze
+      SYMBOLS = {
+        twoheadrightarrowtail: :"⤖",
+        twoheadrightarrow: :"↠",
+        rightarrowtail: :"↣",
+        Leftrightarrow: :"⇔",
+        leftrightarrow: :"↔",
+        Rightarrow: :"⇒",
+        rightarrow: :"→",
+        varepsilon: :"ɛ",
+        Leftarrow: :"⇐",
+        leftarrow: :"←",
+        downarrow: :"↓",
+        therefore: :"∴",
+        backslash: :"\\",
+        setminus: :"\\",
+        triangle: :"△",
+        bigwedge: :"⋀",
+        rceiling: :"⌉",
+        lceiling: :"⌈",
+        supseteq: :"⊇",
+        subseteq: :"⊆",
+        vartheta: :"ϑ",
+        emptyset: :"∅",
+        diamond: :"⋄",
+        uparrow: :"↑",
+        implies: :"⇒",
+        partial: :"∂",
+        because: :"∵",
+        upsilon: :"υ",
+        epsilon: :"ε",
+        bigcap: :"⋂",
+        bigvee: :"⋁",
+        propto: :"∝",
+        approx: :"≈",
+        exists: :"∃",
+        forall: :"∀",
+        otimes: :"⊗",
+        ltimes: :"⋉",
+        bowtie: :"⋈",
+        rtimes: :"⋊",
+        models: :"⊨",
+        mapsto: :"↦",
+        bigcup: :"⋃",
+        succeq: :"⪰",
+        preceq: :"⪯",
+        rfloor: :"⌋",
+        lfloor: :"⌊",
+        square: :"□",
+        supset: :"⊃",
+        subset: :"⊂",
+        lambda: :"λ",
+        Lambda: :"Λ",
+        varphi: :"φ",
+        ">->>": :"⤖",
+        "/_\\": :"△",
+        "|><|": :"&#x22C8;",
+        kappa: :"&#x3BA;",
+        Delta: :"&#x394;",
+        delta: :"&#x3B4;",
+        gamma: :"&#x3B3;",
+        Gamma: :"&#x393;",
+        Theta: :"&#x398;",
+        theta: :"&#x3B8;",
+        alpha: :"&#x3B1;",
+        aleph: :"&#2135;",
+        infty: :"&#221E;",
+        equiv: :"&#2261;",
+        frown: :"&#2322;",
+        notin: :"&#2209;",
+        angle: :"&#2220;",
+        "!in": :"&#x2209;",
+        cdots: :"&#x22EF;",
+        vdash: :"&#x22A2;",
+        wedge: :"&#x2227;",
+        oplus: :"&#x2295;",
+        nabla: :"&#x2207;",
+        ddots: :"&#x22F1;",
+        vdots: :"&#x22EE;",
+        Sigma: :"&#3A3;",
+        Omega: :"&#3A9;",
+        omega: :"&#3C9;",
+        sigma: :"&#3C3;",
+        times: :"&#xD7;",
+        ldots: :"...",
+        ">-=": :"&#x2AB0;",
+        "-<=": :"&#x2AAF;",
+        "><|": :"&#x22CA;",
+        "|==": :"&#x22A8;",
+        "|--": :"&#x22A2;",
+        "^^^": :"&#x22C0;",
+        "|->": :"&#x21A6;",
+        ">->": :"&#x21A3;",
+        "->>": :"&#x21A0;",
+        "__|": :"&#x230B;",
+        "|__": :"&#x230A;",
+        "|><": :"&#x22C9;",
+        "_|_": :"&#x22A5;",
+        "***": :"&#x22C6;",
+        "<=>": :"&#x21D4;",
+        quad: :"&#xA0;&#xA0;",
+        star: :"&#x22C6;",
+        odot: :"&#x2299;",
+        cdot: :"&#x22C5;",
+        rarr: :"&#x2192;",
+        darr: :"&#x2193;",
+        prop: :"&#x221D;",
+        lArr: :"&#x21D0;",
+        rArr: :"&#x21D2;",
+        uarr: :"&#x2191;",
+        hArr: :"&#x21D4;",
+        harr: :"&#x2194;",
+        larr: :"&#x2190;",
+        grad: :"&#x2207;",
+        circ: :"&#x2218;",
+        sube: :"&#x2286;",
+        supe: :"&#x2287;",
+        succ: :"&#227B;",
+        prec: :"&#227A;",
+        cong: :"&#2245;",
+        beta: :"&#x3B2;",
+        zeta: :"&#x3B6;",
+        iota: :"&#x3B9;",
+        ":'": :"&#x2235;",
+        "^^": :"&#x2227;",
+        "o+": :"&#x2295;",
+        "o.": :"&#x2299;",
+        "**": :"&#x2217;",
+        "~~": :"&#x2248;",
+        "O/": :"&#x2205;",
+        "->": :"&#x2192;",
+        "=>": :"&#x21D2;",
+        ">>": :"&#x232A;",
+        "<<": :"&#x2329;",
+        "~|": :"&#x2309;",
+        "!=": :"&#x2260;",
+        ">-": :"&#x227B;",
+        "-<": :"&#x227A;",
+        "~=": :"&#x2245;",
+        "-=": :"&#x2261;",
+        ":.": :"&#x2234;",
+        ">=": :"&#x2265;",
+        "<=": :"&#x2264;",
+        "|~": :"&#x2308;",
+        "/_": :"&#x2220;",
+        "+-": :"&#xB1;",
+        "-:": :"&#xF7;",
+        sup: :"&#x2283;",
+        sub: :"&#x2282;",
+        top: :"&#x22A4;",
+        vvv: :"&#x22C1;",
+        vee: :"&#x2228;",
+        nnn: :"&#x22C2;",
+        cap: :"&#x2229;",
+        ast: :"&#x2217;",
+        bot: :"&#x22A5;",
+        del: :"&#x2202;",
+        uuu: :"&#x22C3;",
+        cup: :"&#x222A;",
+        iff: :"&#x21D4;",
+        eta: :"&#x3B7;",
+        Phi: :"&#x3A6;",
+        Psi: :"&#x3A8;",
+        psi: :"&#x3C8;",
+        chi: :"&#x3C7;",
+        phi: :"&#x3D5;",
+        rho: :"&#x3C1;",
+        tau: :"&#x3C4;",
+        div: :"&#xF7;",
+        neg: :"&#xAC;",
+        not: :"&#xAC;",
+        "@": :"&#x2218;",
+        "*": :"&#x22C5;",
+        "<": :"&lt;",
+        ">": :"&gt;",
+        "-": :"-",
+        "=": :"=",
+        "+": :"+",
+        "/": :"/",
+        nn: :"&#x2229;",
+        vv: :"&#x2228;",
+        TT: :"&#x22A4;",
+        EE: :"&#x2203;",
+        ox: :"&#x2297;",
+        to: :"&#x2192;",
+        AA: :"&#x2200;",
+        uu: :"&#x222A;",
+        ne: :"&#x2260;",
+        ZZ: :"&#x2124;",
+        RR: :"&#x211D;",
+        QQ: :"&#x211A;",
+        NN: :"&#x2115;",
+        CC: :"&#x2102;",
+        oo: :"&#x221E;",
+        ge: :"&#x2265;",
+        le: :"&#x2264;",
+        in: :"&#x2208;",
+        nu: :"&#x3BD;",
+        mu: :"&#x3BC;",
+        pi: :"&#x3C0;",
+        Pi: :"&#x3A0;",
+        xi: :"&#x3BE;",
+        Xi: :"&#x39E;",
+        xx: :"&#xD7;",
+        pm: :"&#xB1;",
+        gt: :"&gt;",
+        lt: :"&lt;",
+      }.freeze
+      UNARY_CLASSES = %i[
+        arccos
+        arcsin
+        arctan
+        ubrace
+        obrace
+        cancel
+        tilde
+        floor
+        ceil
+        ddot
+        coth
+        csch
+        sech
+        sinh
+        tanh
+        cosh
+        sqrt
+        norm
+        text
+        sec
+        sin
+        tan
+        cos
+        exp
+        gcd
+        glb
+        lcm
+        lub
+        cot
+        csc
+        det
+        dim
+        max
+        min
+        abs
+        bar
+        dot
+        hat
+        vec
+        ul
+        ln
+        f
+        g
+      ].freeze
+      BINARY_CLASSES = %i[
+        underset
+        stackrel
+        overset
+        color
+        prod
+        frac
+        root
+        oint
+        int
+        sum
+        mod
+        log
+      ].freeze
+      FONT_STYLES = %i[
+        mathfrak
+        mathcal
+        mathbb
+        mathsf
+        mathtt
+        mathbf
+        bbb
+        bb
+        fr
+        cc
+        sf
+        tt
+      ].freeze
+    end
+  end
+end