Main MRPT website > C++ reference for MRPT 1.4.0
mainPage_doc.h
Go to the documentation of this file.
1/* +---------------------------------------------------------------------------+
2 | The Mobile Robot Programming Toolkit (MRPT) |
3 | |
4 | http://www.mrpt.org/ |
5 | |
6 | Copyright (c) 2005-2012, MAPIR group, University of Malaga |
7 | All rights reserved. |
8 | |
9 | Redistribution and use in source and binary forms, with or without |
10 | modification, are permitted provided that the following conditions are |
11 | met: |
12 | * Redistributions of source code must retain the above copyright |
13 | notice, this list of conditions and the following disclaimer. |
14 | * Redistributions in binary form must reproduce the above copyright |
15 | notice, this list of conditions and the following disclaimer in the |
16 | documentation and/or other materials provided with the distribution. |
17 | * Neither the name of the copyright holders nor the |
18 | names of its contributors may be used to endorse or promote products |
19 | derived from this software without specific prior written permission.|
20 | |
21 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
22 | 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED |
23 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR|
24 | PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE |
25 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL|
26 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR|
27 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
28 | HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
29 | STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
30 | ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
31 | POSSIBILITY OF SUCH DAMAGE. |
32 +---------------------------------------------------------------------------+ */
33
34
35/** \mainpage The Mobile Robot Programming Toolkit (MRPT)
36 *
37
38<div align=center >
39 <b>Version: 1.4.0 SVN:</b> <br>
40</div>
41<hr>
42
43<br>
44
45<a name=intro>
46<h2>Introduction</h2>
47
48This is the home of the MRPT C++ library documentation generated by Doxygen.
49See the <a href=changelog.html > CHANGELOG </a> for this release.
50</p>
51
52You can browse the complete list of classes <a href=annotated.html >here</a>, or use the tabs on the top of this page for looking for a specific namespace,
53hierarchy of classes, etc.
54
55This reference documentation is complementary to the <a href=http://www.mrpt.org/The_MRPT_book/ >MRPT book</a> available for download at the main web site.
56
57
58<br>
59<a name=libs>
60<h2>Libraries / Modules</h2>
61
62Click on a library name to see a summary of its contents,
63or <b>explore the</b> <a href=modules.html ><b>complete list</b></a> <b>of modules</b>.
64Mark meaning:
65- (*): experimental libraries.
66- (.h): Header-only libraries. Don't require any .so/.dll file, just adding #include<>'s to user code.
67
68<div align=center >
69\dot
70digraph MRPT_LIBS {
71
72 node [shape=box,style=filled, fillcolor="#D0D0D0"];
73
74 base [label="mrpt-base",URL="group__mrpt__base__grp.html"];
75 graphs [label="mrpt-graphs (.h)",URL="group__mrpt__graphs__grp.html"];
76 bayes [label="mrpt-bayes (.h)",URL="group__mrpt__bayes__grp.html"];
77 opengl [label="mrpt-opengl", URL="group__mrpt__opengl__grp.html"];
78 gui [label="mrpt-gui",URL="group__mrpt__gui__grp.html"];
79 obs [label="mrpt-obs",URL="group__mrpt__obs__grp.html"];
80 hwdrivers [label="mrpt-hwdrivers",URL="group__mrpt__hwdrivers__grp.html"];
81 topography [label="mrpt-topography",URL="group__mrpt__topography__grp.html"];
82 maps [label="mrpt-maps",URL="group__mrpt__maps__grp.html"];
83 vision [label="mrpt-vision",URL="group__mrpt__vision__grp.html"];
84 tfest [label="mrpt-tfest",URL="group__mrpt__tfest__grp.html"];
85
86 slam [label="mrpt-slam",URL="group__mrpt__slam__grp.html"];
87 graphslam [label="mrpt-graphslam (.h)",URL="group__mrpt__graphslam__grp.html"];
88
89 hmtslam [label="mrpt-hmtslam",URL="group__mrpt__hmtslam__grp.html"];
90 nav [label="mrpt-nav",URL="group__mrpt__nav__grp.html"];
91
92 detectors [label="mrpt-detectors",URL="group__mrpt__detectors__grp.html"];
93
94 kinematics [label="mrpt-kinematics",URL="group__mrpt__kinematics__grp.html"];
95
96 pbmap [label="mrpt-pbmap",URL="group__mrpt__pbmap__grp.html"];
97
98 pbmap -> graphs;
99
100 kinematics -> opengl;
101
102 graphs -> base;
103 tfest -> base;
104
105 bayes -> base;
106
107 opengl -> base;
108
109 obs -> opengl;
110
111 gui -> opengl;
112
113 hwdrivers -> gui;
114 hwdrivers -> maps;
115
116 topography -> obs;
117 topography -> tfest;
118
119 vision -> obs;
120
121 maps -> obs;
122
123 slam -> maps;
124 slam -> vision;
125 slam -> tfest;
126 slam -> bayes;
127 slam -> graphs;
128
129 graphslam -> graphs;
130
131 detectors -> vision;
132 detectors -> maps;
133 detectors -> gui;
134
135 hmtslam -> slam;
136 hmtslam -> graphslam;
137
138 nav -> maps;
139 nav -> graphs;
140}
141
142\enddot
143</div>
144
145Read also <a href=http://www.mrpt.org/Libraries_tree_layout >the guide</a> to write new MRPT libraries.
146
147<br><a name=dependencies>
148<h2>Dependencies</h2>
149
150Check out <a href=dependencies.html >this page</a> to find out what are needed for each of the MRPT build dependencies (opencv, wxWidgets,...)
151to decide if you need them for your applications.
152
153
154
155<br><a name=perf>
156<h2>Performance benchmarks</h2>
157
158Extensive performance tests are automated by means of the application mrpt-performance.
159To see the results on different platforms, as well as a comparison between different
160compilers and platforms, see the <a href=perf-html/index.html> performance page</a>.
161
162
163*/
164
165
166



Page generated by Doxygen 1.9.2 for MRPT 1.4.0 SVN: at Mon Sep 20 00:21:40 UTC 2021