Skip to content

Commit e859228

Browse files
committed
Update internal links
1 parent 8c8d3bf commit e859228

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+104
-104
lines changed

docs/coding-styles/member-vs-free-standing-functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ ax->plot(x, y)->color("red").line_width(2);
4343
my_function(ax);
4444
```
4545

46-
Both examples would generate the same plot. All free-standing functions are templated functions that use meta-programming to call the main function on the current `axes` object. If the first parameter is not an `axes_handle`, it will get an `axes_handle` from the figure registry with `gca` (Section [Axes Object]()) and forward all parameters to the function in this `axes` object. If the first parameter is an `axes_handle`, the template function will forward all parameters, but the first one, to this `axes` object. This use of templates for the free-standing functions keeps both coding styles maintainable by the developers.
46+
Both examples would generate the same plot. All free-standing functions are templated functions that use meta-programming to call the main function on the current `axes` object. If the first parameter is not an `axes_handle`, it will get an `axes_handle` from the figure registry with `gca` (Section [Axes Object](../examples/appearance/axes-object.md)) and forward all parameters to the function in this `axes` object. If the first parameter is an `axes_handle`, the template function will forward all parameters, but the first one, to this `axes` object. This use of templates for the free-standing functions keeps both coding styles maintainable by the developers.
4747

4848
Note that, because the example needs the `axes` object for the function `my_function`, we also need to get a reference to the `axes` object with the free-standing functions. In that case, the free-standing functions are not less verbose than the object-oriented interface.
4949

docs/coding-styles/reactive-figures.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ has_toc: false
1111
There are also two modes for figures: reactive (or interactive) mode and quiet mode. Figures in reactive mode are updated whenever any of their child objects change. This happens through the `touch` function, that gets called on any child object when it changes its appearance. This creates an interactive mode in which figures are updated as soon as we adjust their properties. If we combine interactive figures with free-standing functions, we have a "Matlab-like style" for plots. This is a coding pattern where the figure registry works as a stream for plots.
1212
The problem with this coding style is that the user might unnecessarily create useless intermediary plots.
1313

14-
Figures in quiet mode are updated by calling the functions `draw()` or `show()` (Section [Reactive Figures]()). Unless these functions are called, nothing changes in the figure. The combination of the object-oriented coding style and quiet mode is the "OO-Matplotlib-like style" for plots. This is a coding style in which the user explicitly decides when the plot is shown or updated. This is beneficial to applications that cannot waste computational resources on intermediary figures that might not be valuable to the application.
14+
Figures in quiet mode are updated by calling the functions `draw()` or `show()` (Section [Reactive Figures](reactive-figures.md)). Unless these functions are called, nothing changes in the figure. The combination of the object-oriented coding style and quiet mode is the "OO-Matplotlib-like style" for plots. This is a coding style in which the user explicitly decides when the plot is shown or updated. This is beneficial to applications that cannot waste computational resources on intermediary figures that might not be valuable to the application.
1515

1616
We generally use free-standing functions with reactive mode and the object-oriented interface with quiet mode. By default, new figures are in reactive mode, unless it is using an non-interactive backend. One can turn this reactive mode on and off with:
1717

@@ -31,7 +31,7 @@ p->color("red").line_width(2); // draws twice more
3131
show(); // pause console
3232
```
3333
34-
For convenience, the examples in Section [Examples]() use the reactive mode. The `show` function pauses the console until the user interacts with the plot window. If the backend is based on process pipes, because these are unidirectional, closing the window is not enough to resume. The user needs to use the console to unblock execution. A similar example is quiet mode would be
34+
For convenience, the examples in Section [Examples](../examples.md) use the reactive mode. The `show` function pauses the console until the user interacts with the plot window. If the backend is based on process pipes, because these are unidirectional, closing the window is not enough to resume. The user needs to use the console to unblock execution. A similar example is quiet mode would be
3535
3636
```cpp
3737
// Quiet mode

docs/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ There are many ways in which you can contribute to this library:
1111

1212
* Testing the library in new environments <sup>see [1](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22cross-platform+issue+-+windows%22), [2](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22cross-platform+issue+-+linux%22), [3](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22cross-platform+issue+-+macos%22) </sup>
1313
* Contributing with interesting examples <sup>see [1](https://github.com/alandefreitas/matplotplusplus/blob/master/source/examples)</sup>
14-
* Designing new backends <sup>see [1](https://github.com/alandefreitas/matplotplusplus/blob/master/source/matplot/backend/backend_interface.h), [2](https://github.com/alandefreitas/matplotplusplus/blob/master/test/backends/ogl_main.cpp), [3](), [4](docs/README.md#backends)</sup>
14+
* Designing new backends <sup>see [1](https://github.com/alandefreitas/matplotplusplus/blob/master/source/matplot/backend/backend_interface.h), [2](https://github.com/alandefreitas/matplotplusplus/blob/master/test/backends/ogl_main.cpp), [3](integration/backends.md), [4](README.html#backends)</sup>
1515
* Finding problems in this documentation <sup>see [1](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22enhancement+-+documentation%22) </sup>
1616
* Writing algorithms for new plot categories <sup>see [1](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22enhancement+-+plot+categories%22) </sup>
1717
* Finding bugs in general <sup>see [1](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+compilation+error%22), [2](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+compilation+warning%22), [3](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+runtime+error%22), [4](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+runtime+warning%22) </sup>

docs/examples/annotations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ has_toc: false
88
---
99
# Annotations
1010

11-
[Text]() | [Text with Arrow](#text-with-arrow) | [Rectangle]() | [Filled Polygon](#filled-polygon) | [Ellipse]() | [Textbox](#textbox) | [Arrow]() | [Line](#line)
11+
[Text](annotations/text.md) | [Text with Arrow](annotations/text-with-arrow.md) | [Rectangle](annotations/rectangle.md) | [Filled Polygon](annotations/filled-polygon.md) | [Ellipse](annotations/ellipse.md) | [Textbox](annotations/textbox.md) | [Arrow](annotations/arrow.md) | [Line](annotations/line.md)
1212

1313
The annotations category is meant to create individual objects on the plot rather than representations of data sets. An important difference between the annotations category and other categories is that, by default, the annotations do not replace the plot that already exists in the `axes` object, even if the user does not call the `hold` function.
1414

docs/examples/appearance.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ has_toc: false
88
---
99
# Appearance
1010

11-
* [Labels](): [Title](#title) | [Subplot Title]() | [X Label](#x-label) | [Y Label]() | [Z Label](#z-label) | [Legend]()
12-
* [Axis](): [X Limits](#x-limits) | [Y Limits]() | [Z Limits](#z-limits) | [Adjust Axis]() | [Box](#box)
13-
* [Grid](): [Grid Background](#grid-background) | [X Ticks]() | [Y Ticks](#y-ticks) | [Z Ticks]() | [X Tick Labels](#x-tick-labels) | [Y Tick Labels]() | [X Tick Format](#x-tick-format) | [Y Tick Format]() | [Z Tick Format](#z-tick-format) | [X Tick Angle]() | [Y Tick Angle](#y-tick-angle)
14-
* [Multiplot](): [Hold](#hold) | [YY-axis]() | [Color Order](#color-order) | [Subplots]() | [Tiled Layout](#tiled-layout)
15-
* [Colormaps](): [Colormap](#colormap) | [Color Bar]() | [RGB Plot](#rgb-plot)
16-
* [Camera](): [View](#view) | [Lighting]()
17-
* [Figure Object]()
18-
* [Line Specs]()
19-
* [Axes Object]()
20-
* [Clear Axes]()
11+
* [Labels](appearance/labels.md): [Title](appearance/labels/title.md) | [Subplot Title](appearance/labels/subplot-title.md) | [X Label](appearance/labels/x-label.md) | [Y Label](appearance/labels/y-label.md) | [Z Label](appearance/labels/z-label.md) | [Legend](appearance/labels/legend.md)
12+
* [Axis](appearance/axis.md): [X Limits](appearance/axis/x-limits.md) | [Y Limits](appearance/axis/y-limits.md) | [Z Limits](appearance/axis/z-limits.md) | [Adjust Axis](appearance/axis/adjust-axis.md) | [Box](appearance/axis/box.md)
13+
* [Grid](appearance/grid.md): [Grid Background](appearance/grid/grid-background.md) | [X Ticks](appearance/grid/x-ticks.md) | [Y Ticks](appearance/grid/y-ticks.md) | [Z Ticks](appearance/grid/z-ticks.md) | [X Tick Labels](appearance/grid/x-tick-labels.md) | [Y Tick Labels](appearance/grid/y-tick-labels.md) | [X Tick Format](appearance/grid/x-tick-format.md) | [Y Tick Format](appearance/grid/y-tick-format.md) | [Z Tick Format](appearance/grid/z-tick-format.md) | [X Tick Angle](appearance/grid/x-tick-angle.md) | [Y Tick Angle](appearance/grid/y-tick-angle.md)
14+
* [Multiplot](appearance/multiplot.md): [Hold](appearance/multiplot/hold.md) | [YY-axis](appearance/multiplot/yy-axis.md) | [Color Order](appearance/multiplot/color-order.md) | [Subplots](appearance/multiplot/subplots.md) | [Tiled Layout](appearance/multiplot/tiled-layout.md)
15+
* [Colormaps](appearance/colormaps.md): [Colormap](appearance/colormaps/colormap.md) | [Color Bar](appearance/colormaps/color-bar.md) | [RGB Plot](appearance/colormaps/rgb-plot.md)
16+
* [Camera](appearance/camera.md): [View](appearance/camera/view.md) | [Lighting](appearance/camera/lighting.md)
17+
* [Figure Object](appearance/figure-object.md)
18+
* [Line Specs](appearance/line-specs.md)
19+
* [Axes Object](appearance/axes-object.md)
20+
* [Clear Axes](appearance/clear-axes.md)
2121

2222
As a convenience, the `colors.h` header contains many functions to generate colors from strings and vice-versa.
2323

docs/examples/contour-plots.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ has_toc: false
88
---
99
# Contour Plots
1010

11-
[Contour]() | [Filled Contour](#filled-contour) | [Function Contour]()
11+
[Contour](contour-plots/contour.md) | [Filled Contour](contour-plots/filled-contour.md) | [Function Contour](contour-plots/function-contour.md)
1212

1313

1414

docs/examples/contour-plots/contour.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ contour(X, Y, Z);
1616
1717
See result
1818
19-
[![example_contour_1](https://github.com/alandefreitas/matplotplusplus/blob/master/docs/examples/contour_plots/contour/contour_1.svg)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_1.cpp)
19+
[![example_contour_1](../contour_plots/contour/contour_1.svg)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_1.cpp)
2020
2121
More examples:
2222
23-
[![example_contour_2](https://github.com/alandefreitas/matplotplusplus/blob/master/docs/examples/contour_plots/contour/contour_2_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_2.cpp) [![example_contour_3](https://github.com/alandefreitas/matplotplusplus/blob/master/docs/examples/contour_plots/contour/contour_3_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_3.cpp) [![example_contour_4](https://github.com/alandefreitas/matplotplusplus/blob/master/docs/examples/contour_plots/contour/contour_4_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_4.cpp) [![example_contour_5](https://github.com/alandefreitas/matplotplusplus/blob/master/docs/examples/contour_plots/contour/contour_5_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_5.cpp) [![example_contour_6](https://github.com/alandefreitas/matplotplusplus/blob/master/docs/examples/contour_plots/contour/contour_6_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_6.cpp) [![example_contour_7](https://github.com/alandefreitas/matplotplusplus/blob/master/docs/examples/contour_plots/contour/contour_7_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_7.cpp) [![example_contour_8](https://github.com/alandefreitas/matplotplusplus/blob/master/docs/examples/contour_plots/contour/contour_8_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_8.cpp)
23+
[![example_contour_2](../contour_plots/contour/contour_2_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_2.cpp) [![example_contour_3](../contour_plots/contour/contour_3_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_3.cpp) [![example_contour_4](../contour_plots/contour/contour_4_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_4.cpp) [![example_contour_5](../contour_plots/contour/contour_5_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_5.cpp) [![example_contour_6](../contour_plots/contour/contour_6_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_6.cpp) [![example_contour_7](../contour_plots/contour/contour_7_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_7.cpp) [![example_contour_8](../contour_plots/contour/contour_8_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contour/contour_8.cpp)
2424
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.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ contourf(X, Y, Z);
1616
1717
See result
1818
19-
[![example_contourf_1](https://github.com/alandefreitas/matplotplusplus/blob/master/docs/examples/contour_plots/contourf/contourf_1.svg)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contourf/contourf_1.cpp)
19+
[![example_contourf_1](../contour_plots/contourf/contourf_1.svg)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contourf/contourf_1.cpp)
2020
2121
More examples:
2222
23-
[![example_contourf_2](https://github.com/alandefreitas/matplotplusplus/blob/master/docs/examples/contour_plots/contourf/contourf_2_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contourf/contourf_2.cpp) [![example_contourf_3](https://github.com/alandefreitas/matplotplusplus/blob/master/docs/examples/contour_plots/contourf/contourf_3_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contourf/contourf_3.cpp) [![example_contourf_4](https://github.com/alandefreitas/matplotplusplus/blob/master/docs/examples/contour_plots/contourf/contourf_4_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contourf/contourf_4.cpp) [![example_contourf_5](https://github.com/alandefreitas/matplotplusplus/blob/master/docs/examples/contour_plots/contourf/contourf_5_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contourf/contourf_5.cpp) [![example_contourf_6](https://github.com/alandefreitas/matplotplusplus/blob/master/docs/examples/contour_plots/contourf/contourf_6_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contourf/contourf_6.cpp)
23+
[![example_contourf_2](../contour_plots/contourf/contourf_2_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contourf/contourf_2.cpp) [![example_contourf_3](../contour_plots/contourf/contourf_3_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contourf/contourf_3.cpp) [![example_contourf_4](../contour_plots/contourf/contourf_4_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contourf/contourf_4.cpp) [![example_contourf_5](../contour_plots/contourf/contourf_5_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contourf/contourf_5.cpp) [![example_contourf_6](../contour_plots/contourf/contourf_6_thumb.png)](https://github.com/alandefreitas/matplotplusplus/blob/master/examples/contour_plots/contourf/contourf_6.cpp)
2424
2525
2626

0 commit comments

Comments
 (0)