Skip to content

Commit d0ef918

Browse files
committed
Update Docs
1 parent 494acab commit d0ef918

File tree

8 files changed

+20
-20
lines changed

8 files changed

+20
-20
lines changed

docs/contributing/contributors.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -40,25 +40,25 @@ has_toc: false
4040
</a>
4141
</td>
4242
<td align="center">
43-
<a href="https://github.com/sammi">
44-
<img src="https://avatars0.githubusercontent.com/u/189128?v=4" width="100;" alt="sammi"/>
43+
<a href="https://github.com/actions-user">
44+
<img src="https://avatars1.githubusercontent.com/u/65916846?v=4" width="100;" alt="actions-user"/>
4545
<br />
46-
<sub><b>Sammi</b></sub>
46+
<sub><b>Actions-user</b></sub>
4747
</a>
4848
</td>
4949
<td align="center">
50-
<a href="https://github.com/dimztimz">
51-
<img src="https://avatars0.githubusercontent.com/u/6236568?v=4" width="100;" alt="dimztimz"/>
50+
<a href="https://github.com/sammi">
51+
<img src="https://avatars0.githubusercontent.com/u/189128?v=4" width="100;" alt="sammi"/>
5252
<br />
53-
<sub><b>Dimitrij Mijoski</b></sub>
53+
<sub><b>Sammi</b></sub>
5454
</a>
5555
</td></tr>
5656
<tr>
5757
<td align="center">
58-
<a href="https://github.com/actions-user">
59-
<img src="https://avatars1.githubusercontent.com/u/65916846?v=4" width="100;" alt="actions-user"/>
58+
<a href="https://github.com/dimztimz">
59+
<img src="https://avatars0.githubusercontent.com/u/6236568?v=4" width="100;" alt="dimztimz"/>
6060
<br />
61-
<sub><b>actions-user</b></sub>
61+
<sub><b>Dimitrij Mijoski</b></sub>
6262
</a>
6363
</td>
6464
<td align="center">

docs/examples/annotations/rectangle.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ More examples:
2323
[![example_rectangle_2](rectangle/rectangle_2_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/annotations/rectangle/rectangle_2.cpp) [![example_rectangle_3](rectangle/rectangle_3_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/annotations/rectangle/rectangle_3.cpp) [![example_rectangle_4](rectangle/rectangle_4_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/annotations/rectangle/rectangle_4.cpp) [![example_rectangle_5](rectangle/rectangle_5_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/annotations/rectangle/rectangle_5.cpp)
2424
2525
26-
The rectangle object can have a border curvature from $0$ to $1$. We can also annotate with text, arrows, polygons, and lines.
26+
The rectangle object can have a border curvature from <img src="https://render.githubusercontent.com/render/math?math=0"> to <img src="https://render.githubusercontent.com/render/math?math=1">. We can also annotate with text, arrows, polygons, and lines.
2727
2828
2929

docs/examples/contour-plots/contour.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ More examples:
2525
2626
All these subcategories depend on the `contours` type. They also depend on lazy evaluation for generating the contour lines. When the function `draw` is called in the `contours` class, it preprocesses all contour lines for a three-dimensional function.
2727
28-
Although it is relatively simple to show a heatmap with the values for the $z$-axis, calculating contour lines relative to the $z$-axis is more complex than it might seem at first. We provide the function `contourc` for calculating contour lines. This function uses an adaptation of the algorithm adopted by Matplotlib.
28+
Although it is relatively simple to show a heatmap with the values for the <img src="https://render.githubusercontent.com/render/math?math=z">-axis, calculating contour lines relative to the <img src="https://render.githubusercontent.com/render/math?math=yz">-axis is more complex than it might seem at first. We provide the function `contourc` for calculating contour lines. This function uses an adaptation of the algorithm adopted by Matplotlib.
2929
30-
The algorithm creates a quad grid defined by the $x$ and $y$ values. It uses this grid to infer a contour line passing through positions with the same $z$ value. The algorithm sweeps through the grid twice to generate these lines. The first sweep looks for lines that start on the boundaries. The second sweep looks for interior closed loops.
30+
The algorithm creates a quad grid defined by the <img src="https://render.githubusercontent.com/render/math?math=x"> and <img src="https://render.githubusercontent.com/render/math?math=y"> values. It uses this grid to infer a contour line passing through positions with the same <img src="https://render.githubusercontent.com/render/math?math=z"> value. The algorithm sweeps through the grid twice to generate these lines. The first sweep looks for lines that start on the boundaries. The second sweep looks for interior closed loops.
3131
3232
Filled contours are closed polygons for pairs of contour levels. Some polygons for filled contours might be holes inside other polygons. The algorithm needs to keep track of these relationships so that we can render the polygons in their accurate order. To avoid an extra step that identifies this relationship between the polygons, the sweeping algorithm already identifies which polygons are holes for each level.
3333
34-
Once we find the quads with the contour line, the line is generated by interpolating the $z$ values around that quad.
34+
Once we find the quads with the contour line, the line is generated by interpolating the <img src="https://render.githubusercontent.com/render/math?math=z"> values around that quad.
3535
3636
3737

docs/examples/contour-plots/function-contour.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ More examples:
2323
[![example_fcontour_2](../contour_plots/fcontour/fcontour_2_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/fcontour/fcontour_2.cpp) [![example_fcontour_3](../contour_plots/fcontour/fcontour_3_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/fcontour/fcontour_3.cpp) [![example_fcontour_4](../contour_plots/fcontour/fcontour_4_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/fcontour/fcontour_4.cpp) [![example_fcontour_5](../contour_plots/fcontour/fcontour_5_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/fcontour/fcontour_5.cpp) [![example_fcontour_6](../contour_plots/fcontour/fcontour_6_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/fcontour/fcontour_6.cpp) [![example_fcontour_7](../contour_plots/fcontour/fcontour_7_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/fcontour/fcontour_7.cpp) [![example_fcontour_8](../contour_plots/fcontour/fcontour_8_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/fcontour/fcontour_8.cpp) [![example_fcontour_9](../contour_plots/fcontour/fcontour_9_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/fcontour/fcontour_9.cpp) [![example_fcontour_10](../contour_plots/fcontour/fcontour_10_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/fcontour/fcontour_10.cpp) [![example_fcontour_11](../contour_plots/fcontour/fcontour_11_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/fcontour/fcontour_11.cpp)
2424
2525
26-
By default, the function `fcontour` will generate 9 contour lines from a lambda function. The functions `contour` and `contourf`, on the other hand, plot contour lines and filled contour lines from a grid of data points for $x$, $y$, and $z$.
26+
By default, the function `fcontour` will generate 9 contour lines from a lambda function. The functions `contour` and `contourf`, on the other hand, plot contour lines and filled contour lines from a grid of data points for <img src="https://render.githubusercontent.com/render/math?math=x">, <img src="https://render.githubusercontent.com/render/math?math=y">, and <img src="https://render.githubusercontent.com/render/math?math=z">.
2727
2828
2929

docs/examples/discrete-data/pareto-chart.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ More examples:
2323
[![example_pareto_2](../discrete_data/pareto/pareto_2_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/discrete_data/pareto/pareto_2.cpp) [![example_pareto_3](../discrete_data/pareto/pareto_3_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/discrete_data/pareto/pareto_3.cpp) [![example_pareto_4](../discrete_data/pareto/pareto_4_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/discrete_data/pareto/pareto_4.cpp)
2424
2525
26-
Pareto Charts are a type of chart that uses both $y$ axes. The $y_1$ axis is used to represent bars with the data values in descending order. The $y_2$ axis is used to represent the cumulative distribution function of the data in the $y_1$ axis. By default, a Pareto Chart includes up to 10 items or as many items as needed to represent 95% of the cumulative distribution.
26+
Pareto Charts are a type of chart that uses both <img src="https://render.githubusercontent.com/render/math?math=y"> axes. The <img src="https://render.githubusercontent.com/render/math?math=y_1"> axis is used to represent bars with the data values in descending order. The <img src="https://render.githubusercontent.com/render/math?math=y_2"> axis is used to represent the cumulative distribution function of the data in the <img src="https://render.githubusercontent.com/render/math?math=y_1"> axis. By default, a Pareto Chart includes up to 10 items or as many items as needed to represent 95% of the cumulative distribution.
2727
2828
If you need Pareto *fronts* rather than Pareto *charts*, we refer to [Scatter Plots](../data-distribution/scatter-plot.md) for two-dimensional fronts, [Plot matrices](../data-distribution/plot-matrix.md) for three-dimensional fronts, or [Parallel Coordinate Plots](../data-distribution/parallel-coordinates.md) for many-objective fronts. These plot subcategories are described in Section [Data Distribution](../data-distribution.md). If you also need a tool to calculate these fronts efficiently, we refer to the [Pareto Front Library](https://github.com/alandefreitas/pareto-front).
2929

docs/examples/geography/geoplot.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ More examples:
2525
2626
For the first geography plot, **Matplot++** calls `geoplot()`, which creates a filled polygon with the world map. This first plot receives the tag `"map"` so that subsequent geography plots recognize there is no need to recreate this world map.
2727
28-
The data for the world map comes from Natural Earth. They provide data at 1:10m, 1:50m, and 1:110m scales. The `geoplot` function will initially use the data at the 1:110m scales. The `geolimits` function can be used to update the axis limits for geography plots. The difference between the usual functions for adjusting axis limits (`xlim` and `ylim`) and `geolimits` is that the latter will also update the map resolution according to the new limits for the $x$ and $y$ axis.
28+
The data for the world map comes from Natural Earth. They provide data at 1:10m, 1:50m, and 1:110m scales. The `geoplot` function will initially use the data at the 1:110m scales. The `geolimits` function can be used to update the axis limits for geography plots. The difference between the usual functions for adjusting axis limits (`xlim` and `ylim`) and `geolimits` is that the latter will also update the map resolution according to the new limits for the <img src="https://render.githubusercontent.com/render/math?math=x"> and <img src="https://render.githubusercontent.com/render/math?math=y"> axis.
2929
3030
The `geolimits` function will query the `figure` size and, depending on the new limits for the axes, update the map to the 1:10m, or 1:50m scales if needed. Because it would be very inefficient to render the whole world map at a 1:10m or 1:50m scale only to display a region of this map, the `geolimits` function also crops the data pertinent to the new region being displayed.
3131
3232
Note that this does not only involve removing data points outside the new limits but it also needs to create new data points on the correct borders to create new polygons coherent with the map entry points in the region. For this reason, the algorithm needs to track all submaps represented as closed polygons in the original world map. If submaps are completely inside or outside the new ranges, we can respectively include or dismiss the data points. However, if the submap is only partially inside the new limits, to generate the correct borders for the polygons, we need to track all points outside the limits to classify the directions of these points outside the limits. We do that by only including points that change quadrants around the new limits so that the map entry points create polygons that look like they would if the complete world map were still being rendered outside these new limits.
3333
3434
If the you are not interested in geographic plots, the build script includes an option to remove the high-resolution maps at 1:10m and 1:50m scales from the library. In this case, the library will always use the map at a 1:110m scale no matter the axis limits.
3535
36-
The function `world_cities` returns a list of major world cities. Its parameters define the minimum distances between cities in the $x$ and $y$ axes. The `greedy_tsp` function is a naive greedy algorithm to find a route between these cities as a Traveling Salesman Problem (TSP). We use the `geoplot` function to draw this route. Note that we use method chaining to define some further plot properties. Finally, the `text` function includes the city names in the map.
36+
The function `world_cities` returns a list of major world cities. Its parameters define the minimum distances between cities in the <img src="https://render.githubusercontent.com/render/math?math=x"> and <img src="https://render.githubusercontent.com/render/math?math=y"> axes. The `greedy_tsp` function is a naive greedy algorithm to find a route between these cities as a Traveling Salesman Problem (TSP). We use the `geoplot` function to draw this route. Note that we use method chaining to define some further plot properties. Finally, the `text` function includes the city names in the map.
3737
3838
3939

docs/examples/polar-plots/polar-line-plot.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ More examples:
2323
[![example_polarplot_2](../polar_plots/polarplot/polarplot_2_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/polar_plots/polarplot/polarplot_2.cpp) [![example_polarplot_3](../polar_plots/polarplot/polarplot_3_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/polar_plots/polarplot/polarplot_3.cpp) [![example_polarplot_4](../polar_plots/polarplot/polarplot_4_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/polar_plots/polarplot/polarplot_4.cpp) [![example_polarplot_5](../polar_plots/polarplot/polarplot_5_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/polar_plots/polarplot/polarplot_5.cpp) [![example_polarplot_6](../polar_plots/polarplot/polarplot_6_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/polar_plots/polarplot/polarplot_6.cpp) [![example_polarplot_7](../polar_plots/polarplot/polarplot_7_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/polar_plots/polarplot/polarplot_7.cpp) [![example_polarplot_8](../polar_plots/polarplot/polarplot_8_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/polar_plots/polarplot/polarplot_8.cpp)
2424
2525
26-
By emplacing a polar plot in the `axes`, the `axes` move to a polar mode, where we use the $r$ and $t$ axis instead of the $x$ and $y$ axis.
26+
By emplacing a polar plot in the `axes`, the `axes` move to a polar mode, where we use the <img src="https://render.githubusercontent.com/render/math?math=r"> and <img src="https://render.githubusercontent.com/render/math?math=t"> axis instead of the <img src="https://render.githubusercontent.com/render/math?math=x"> and <img src="https://render.githubusercontent.com/render/math?math=y"> axis.
2727
28-
From the backend point of view, these axes are an abstraction to the user. The data points in the $r$ and $t$ axis are drawn by converting the positions from the polar coordinates $r$ and $t$ to the Cartesian coordinates $x$ and $y$ with the relationships $x=r \cos{t}$ and $y=r \sin{t}$.
28+
From the backend point of view, these axes are an abstraction to the user. The data points in the <img src="https://render.githubusercontent.com/render/math?math=r"> and <img src="https://render.githubusercontent.com/render/math?math=t"> axis are drawn by converting the positions from the polar coordinates <img src="https://render.githubusercontent.com/render/math?math=r"> and <img src="https://render.githubusercontent.com/render/math?math=t"> to the Cartesian coordinates <img src="https://render.githubusercontent.com/render/math?math=x"> and <img src="https://render.githubusercontent.com/render/math?math=y"> with the relationships <img src="https://render.githubusercontent.com/render/math?math=x=r\cos{t}"> and <img src="https://render.githubusercontent.com/render/math?math=y=r\sin{t}">.
2929
3030
Aside from this conversion, these plot subcategories are analogous to line plots, scatter plots, histograms, quiver plots, and line functions.
3131

docs/examples/vector-fields/quiver.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ More examples:
2323
[![example_quiver_2](../vector_fields/quiver/quiver_2_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/vector_fields/quiver/quiver_2.cpp) [![example_quiver_3](../vector_fields/quiver/quiver_3_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/vector_fields/quiver/quiver_3.cpp) [![example_quiver_4](../vector_fields/quiver/quiver_4_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/vector_fields/quiver/quiver_4.cpp)
2424
2525
26-
All these subcategories depend on the `vectors` object type. In a two-dimensional plot, for each value of $x$ and $y$ with the position of a vector, it also requires the value of $u$ and $v$ indicating its direction and magnitude. In a three-dimensional plot, the direction and magnitude are defined by $u$, $v$, and $w$.
26+
All these subcategories depend on the `vectors` object type. In a two-dimensional plot, for each value of <img src="https://render.githubusercontent.com/render/math?math=x"> and <img src="https://render.githubusercontent.com/render/math?math=y"> with the position of a vector, it also requires the value of <img src="https://render.githubusercontent.com/render/math?math=u"> and <img src="https://render.githubusercontent.com/render/math?math=v"> indicating its direction and magnitude. In a three-dimensional plot, the direction and magnitude are defined by <img src="https://render.githubusercontent.com/render/math?math=u">, <img src="https://render.githubusercontent.com/render/math?math=v">, and <img src="https://render.githubusercontent.com/render/math?math=w">.
2727
2828
2929
A quiver plot (or velocity plot) shows a grid of vectors whose direction and magnitude are scaled to prevent the overlap between vectors in subsequent quads.

0 commit comments

Comments
 (0)