summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/luacas/doc/reference/ref_core/ref_core.tex
blob: 668eda73a1e0ed2f290288cd28f56be70169d4e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
\documentclass{article}

\usepackage{luacas}
\usepackage{amsmath}
\usepackage{amssymb}

\usepackage[margin=1in]{geometry}
\usepackage[shortlabels]{enumitem}

\usepackage{pgfplots}
\pgfplotsset{compat=1.18}
\usetikzlibrary{positioning,calc}
\usepackage{forest}
\usepackage{minted}
\usemintedstyle{pastie}
\usepackage[hidelinks]{hyperref}
\usepackage{parskip}
\usepackage{multicol}
\usepackage[most]{tcolorbox}
    \tcbuselibrary{xparse,documentation}
\usepackage{microtype}
\usepackage{makeidx}

\usepackage[
backend=biber,
style=numeric,
]{biblatex}
\addbibresource{sources.bib}

\definecolor{rose}{RGB}{128,0,0}
\definecolor{roseyellow}{RGB}{222,205,99}
\definecolor{roseblue}{RGB}{167,188,214}
\definecolor{rosenavy}{RGB}{79,117,139}
\definecolor{roseorange}{RGB}{232,119,34}
\definecolor{rosegreen}{RGB}{61,68,30}
\definecolor{rosewhite}{RGB}{223,209,167}
\definecolor{rosebrown}{RGB}{108,87,27}
\definecolor{rosegray}{RGB}{84,88,90}

\definecolor{codegreen}{HTML}{49BE25}

\newtcolorbox{codebox}[1][sidebyside]{
    enhanced,skin=bicolor,
    #1,
    arc=1pt,
    colframe=brown,
    colback=brown!15,colbacklower=white,
    boxrule=1pt,
    notitle
}

\newtcolorbox{codehead}[1][]{
    enhanced,
    frame hidden,
    colback=rosegray!15,
    boxrule=0mm,
    leftrule=5mm,
    rightrule=5mm,
    boxsep=0mm,
    arc=0mm,
    outer arc=0mm,
    left=3mm,
    right=3mm,
    top=1mm,
    bottom=1mm,
    toptitle=1mm,
    bottomtitle=1mm,
    oversize,
    #1
}

\usepackage{varwidth}

\newtcolorbox{newcodehead}[2][]{
    enhanced,
    frame hidden,
    colback=rosegray!15,
    boxrule=0mm,
    leftrule=5mm,
    rightrule=5mm,
    boxsep=0mm,
    arc=0mm,
    outer arc=0mm,
    left=3mm,
    right=3mm,
    top=1mm,
    bottom=1mm,
    toptitle=1mm,
    bottomtitle=1mm,
    oversize,
    #1,
    fonttitle=\bfseries\ttfamily\footnotesize,
    coltitle=rosegray,
    attach boxed title to top text right,
    boxed title style={frame hidden,size=small,bottom=-1mm,
    interior style={fill=none,
    top color=white,
    bottom color=white}},
    title={#2}
}

\makeindex

\newcommand{\coderef}[2]{%
\index{\currref!\texttt{#1}}%
\begin{codehead}[sidebyside,segmentation hidden]%
    \mintinline{lua}{#1}%
    \tcblower%
    \begin{flushright}%
    \mintinline{lua}{#2}%
    \end{flushright}%
\end{codehead}%
}

\newcommand{\newcoderef}[3]{%
\index{\currref!\texttt{#1}}%
\begin{newcodehead}[sidebyside,segmentation hidden]{#3}%
    \mintinline{lua}{#1}%
    \tcblower%
    \begin{flushright}%
    \mintinline{lua}{#2}%
    \end{flushright}%
\end{newcodehead}%
}
\usetikzlibrary{shapes.multipart}
\useforestlibrary{edges}

\def\error{\color{red}}
\def\self{\color{gray}}
\def\call{}

\begin{document}
\thispagestyle{empty}

\section{Core}
    This section contains reference materials for the core functionality of \texttt{luacas}. The classes in this module are diagramed below according to inheritance along with the methods/functions one can call upon them.
    \begin{itemize}
        \item {\error\ttfamily\itshape method}: an abstract method (a method that must be implemented by a subclass to be called);
        \item {\self\ttfamily\itshape method}: a method that returns the expression unchanged;
        \item {\ttfamily\itshape method}: a method that is either unique, implements an abstract method, or overrides an abstract method;
        \item {\tikz[baseline=-0.5ex]\node[fill=roseblue!50] {\ttfamily\bfseries Class};}: a concrete class.
    \end{itemize}

\forestset{
rect/.style = {rectangle split,
               rectangle split parts=2,
               draw = {rosenavy,thick},
               rounded corners = 1pt,
               font = \ttfamily\bfseries,
               }
}
\tikzset{
    every two node part/.style={font=\ttfamily\itshape\footnotesize}
}
\begin{center}
    \begin{forest}
        for tree = {node options={align=left},
                           rect,
                           grow= south,
                           parent anchor=south,
                           child anchor=north,
                           edge = {-stealth}
                    },
                    forked edges
        [Expression\nodepart{two}\begin{minipage}{0.5\textwidth}\vskip-0.2cm\begin{multicols}{2}
            {\error :evaluate()} \\
            {\error :autosimplify()} \\
            :simplify() \\
            :size() \\
            {\error :subexpressions()} \\
            {\error :setsubexpressions()} \\
            {\error :freeof(symbol)} \\
            {\error :substitute(map)} \\
            {\self :expand()} \\
            {\self :factor()} \\
            {\self :combine()} \\
            :getsubexpressionsrec() \\
            {\error :isatomic()} \\
            {\error :isconstant()} \\
            :isrealconstant() \\
            :iscomplexconstant() \\
            {\error :order(other)} \\
            {\self :topolynomial()} \\
            {\error :tolatex()} \\
            :type()\end{multicols}\end{minipage}
            [AtomicExpression\nodepart{two}
                {\self :tocompoundexpression()} \\
                {\self :evaluate()} \\
                {\self :autosimplify()} \\
                :subexpressions() \\
                {\self :setsubexpressions()} \\
                :substitute(map) \\
                :isatomic() \\
                :tolatex()
                [SymbolExpression\nodepart{two}
                    {\call :new(symbol)} \\
                    :freeof(symbol) \\
                    :isconstant() \\
                    :order(other) \\
                    :topolynomial()
                ,fill = roseblue!50]
                [ConstantExpression\nodepart{two}
                    :freeof(symbol)\\
                    :isconstant() \\
                    :order(other)
                ]
            ]
            [CompoundExpression\nodepart{two}
                :freeof(symbol) \\
                :substitute(map) \\
                :isatomic() \\
                :isconstant()
                [BinaryOperation\nodepart{two}
                    {\call :new(operation,expressions)} \\
                    :evaluate() \\
                    :autosimplify() (!)\\
                    :subexpressions() \\
                    :setsubexpressions() \\
                    :expand() \\
                    :factor() \\
                    :combine() \\
                    :order(other) \\
                    {:iscommutatitve()}\\
                    :topolynomial() \\
                    :tolatex()
                , fill=roseblue!50]
                [FunctionExpression\nodepart{two}
                    {\call :new(name,expressions)}\\
                    :evaluate()\\
                    :autosimplify()\\
                    :subexpressions()\\
                    :setsubexpressions()\\
                    :order(other)\\
                    :tolatex()
                , fill=roseblue!50]
            ]
        ]
    \end{forest}
\end{center}
The number of core methods should generally be kept small, since every new type of expression must implement all of these methods. The exception to this, of course, is core methods that call other core methods that provide a unified interface to expressions. For instance, {\ttfamily size()} calls {\ttfamily subexpressions()}, so it only needs to be implemented in the expression interface.

All expressions should also implement the {\ttfamily \_\_tostring} and {\ttfamily \_\_eq} metamethods. Metamethods cannot be inherited using Lua, thus every expression object created by a constructor must assign a metatable to that object.

\begin{itemize}
    \item {\ttfamily \_\_tostring} provides a human-readable version of an expression for printing within Lua and exporting to external programs.

    \item {\ttfamily \_\_eq} determines whether an expression is structurally identical to another expression.
\end{itemize}
\end{document}