forked from Cryoris/matplotlib-cpp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
299 lines (189 loc) · 11.4 KB
/
Copy pathindex.html
File metadata and controls
299 lines (189 loc) · 11.4 KB
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Home — Matplotlib for C++ documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="First examples" href="examples.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> Matplotlib for C++
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Content</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="examples.html">First examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling a program</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs.html">The Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="style.html">The style of a line</a></li>
<li class="toctree-l1"><a class="reference internal" href="problems.html">Frequent problems</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html#questions">Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">To do</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Matplotlib for C++</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>Home</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="home">
<h1>Home<a class="headerlink" href="#home" title="Permalink to this headline">¶</a></h1>
<p>This is the documentation to <em>Matplotlib for C++</em>, a C++ wrapper
for Python’s <cite>matplotlib</cite> (MPL) plotting library.</p>
<p>The code is organised in <a class="reference external" href="https://github.com/Cryoris/matplotlib-cpp">this</a>
GitHub repository, which is a fork of
<a class="reference external" href="https://github.com/lava/matplotlib-cpp">that</a> repository.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p><em>This is</em>:
A lightweight, easy-to-use interface to create stylish and clean plots in C++
using basic MPL commands.</p>
<p class="last"><em>This is</em> <strong>not</strong>:
A translation of MPL to C++.</p>
</div>
<div class="section" id="how-to-use-this-documentation">
<h2>How to use this documentation<a class="headerlink" href="#how-to-use-this-documentation" title="Permalink to this headline">¶</a></h2>
<div class="section" id="function-definitions">
<h3>Function definitions<a class="headerlink" href="#function-definitions" title="Permalink to this headline">¶</a></h3>
<p>This is the core of the documentation, located at <a class="reference internal" href="docs.html#docs"><span class="std std-ref">The Docs</span></a>.
To find the definition and explanations for a special command use
the search field on the top left, since this page can get a bit lengthy.</p>
<p>Bear in mind, that <cite>matplotlibcpp</cite> is a C++ wrapper to the Python
library MPL. Thus, to learn more about the functions that
are eventually called the <a class="reference external" href="https://matplotlib.org/3.1.1/index.html">matplotlib documentation</a> might be useful.
Most functions have a link to the MPL function they call, marked
with the MPL logo:</p>
<a class="reference external image-reference" href="https://matplotlib.org/3.1.1/index.html"><img alt="Clicking here leads to the corresponding function definition in MPL" class="align-center" src="_images/matplotlib_icon1.png" style="width: 20px; height: 20px;" /></a>
<p>However, the function signatures might differ and Matplotlib for C++ does
<em>not</em> support the full functionality of MPL.
The purpose is providing an easy-to-use wrapper to MPL in C++, not
to fully translate the library.</p>
</div>
<div class="section" id="help-for-compiling">
<h3>Help for compiling<a class="headerlink" href="#help-for-compiling" title="Permalink to this headline">¶</a></h3>
<p>The section <a class="reference internal" href="compiling.html#compiling"><span class="std std-ref">Compiling a program</span></a> explains the compilations of
a program using the <code class="docutils literal notranslate"><span class="pre">matplotlibcpp.h</span></code> header.</p>
</div>
<div class="section" id="style-of-a-line">
<h3>Style of a line<a class="headerlink" href="#style-of-a-line" title="Permalink to this headline">¶</a></h3>
<p>Refer <a class="reference internal" href="style.html#style"><span class="std std-ref">The style of a line</span></a> to tune the appearance of the lines you plot.</p>
</div>
<div class="section" id="frequent-problems">
<h3>Frequent problems<a class="headerlink" href="#frequent-problems" title="Permalink to this headline">¶</a></h3>
<p><a class="reference internal" href="problems.html#problems"><span class="std std-ref">Frequent problems</span></a> lists typical problems with Matplotlib for C++
and (hopefully) how to resolve them.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">Criticism (preferably constructive), ideas and contributions
are welcome! For contact, see <a class="reference internal" href="license.html#questions"><span class="std std-ref">Questions</span></a>.</p>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Content</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="examples.html">First examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples.html#minimal-working-example">Minimal working example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#standard-usage">Standard usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#eigen-vectors">Eigen vectors</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling a program</a><ul>
<li class="toctree-l2"><a class="reference internal" href="compiling.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="compiling.html#includes-and-linking">Includes and Linking</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="docs.html">The Docs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docs.html#matplotlibcpp-namespace"><cite>matplotlibcpp</cite> namespace</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs.html#vector-type"><cite>Vector</cite> type</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs.html#plot-commands">Plot commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs.html#figure-commands">Figure commands</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="style.html">The style of a line</a><ul>
<li class="toctree-l2"><a class="reference internal" href="style.html#marker">Marker</a></li>
<li class="toctree-l2"><a class="reference internal" href="style.html#line">Line</a></li>
<li class="toctree-l2"><a class="reference internal" href="style.html#color">Color</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="problems.html">Frequent problems</a><ul>
<li class="toctree-l2"><a class="reference internal" href="problems.html#figure-layout">Figure layout</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html#questions">Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">To do</a><ul>
<li class="toctree-l2"><a class="reference internal" href="todo.html#generalise-to-vector">Generalise to Vector</a></li>
<li class="toctree-l2"><a class="reference internal" href="todo.html#layout">Layout</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="examples.html" class="btn btn-neutral float-right" title="First examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright Documentation: 2019, Julien Gacon. Library: 2014, Benno Evers
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>