Main MRPT website > C++ reference for MRPT 1.9.9
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-2018, 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.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700</b> <br>
40 </div>
41 <hr>
42 
43 <br>
44 
45 <a name=intro>
46 <h2>Introduction</h2>
47 
48 This is the home of the MRPT C++ library documentation generated by Doxygen.
49 See the <a href=changelog.html > CHANGELOG </a> for this release.
50 </p>
51 
52 You 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,
53 hierarchy of classes, etc.
54 
55 This 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 
62 Click on a library name to see a summary of its contents,
63 or <b>explore the</b> <a href=modules.html ><b>complete list</b></a> <b>of modules</b>.
64 Mark 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
70 digraph MRPT_LIBS {
71 
72  node [shape=box,style=filled, fillcolor="#D0D0D0"];
73 
74  bayes [label="mrpt-bayes",URL="group__mrpt__bayes__grp.html"];
75  bayes -> math;
76  bayes -> config;
77 
78  comms [label="mrpt-comms",URL="group__mrpt__comms__grp.html"];
79  comms -> io;
80 
81  config [label="mrpt-config",URL="group__mrpt__config__grp.html"];
82  config -> expr;
83  config -> system;
84 
85  containers [label="mrpt-containers",URL="group__mrpt__containers__grp.html"];
86  containers -> core;
87 
88  { rank = sink;
89  core [label="mrpt-core",URL="group__mrpt__core__grp.html"];
90  }
91 
92  db [label="mrpt-db",URL="group__mrpt__db__grp.html"];
93  db -> serialization;
94  db -> system;
95 
96  detectors [label="mrpt-detectors",URL="group__mrpt__detectors__grp.html"];
97  detectors -> gui;
98  detectors -> slam;
99 
100  expr [label="mrpt-expr",URL="group__mrpt__expr__grp.html"];
101  expr -> core;
102 
103  graphs [label="mrpt-graphs",URL="group__mrpt__graphs__grp.html"];
104  graphs -> opengl;
105 
106  graphslam [label="mrpt-graphslam",URL="group__mrpt__graphslam__grp.html"];
107  graphslam -> gui;
108  graphslam -> slam;
109 
110  gui [label="mrpt-gui",URL="group__mrpt__gui__grp.html"];
111  gui -> opengl;
112 
113  hmtslam [label="mrpt-hmtslam",URL="group__mrpt__hmtslam__grp.html"];
114  hmtslam -> graphslam;
115 
116  hwdrivers [label="mrpt-hwdrivers",URL="group__mrpt__hwdrivers__grp.html"];
117  hwdrivers -> comms;
118  hwdrivers -> gui;
119  hwdrivers -> maps;
120  hwdrivers -> vision;
121 
122  img [label="mrpt-img",URL="group__mrpt__img__grp.html"];
123  img -> io;
124  img -> math;
125  img -> config;
126 
127  io [label="mrpt-io",URL="group__mrpt__io__grp.html"];
128  io -> system;
129 
130  kinematics [label="mrpt-kinematics",URL="group__mrpt__kinematics__grp.html"];
131  kinematics -> opengl;
132 
133  maps [label="mrpt-maps",URL="group__mrpt__maps__grp.html"];
134  maps -> graphs;
135  maps -> obs;
136 
137  math [label="mrpt-math",URL="group__mrpt__math__grp.html"];
138  math -> serialization;
139  math -> random;
140  math -> system;
141  math -> nanoflann;
142 
143  { rank = sink;
144  nanoflann [label="mrpt-nanoflann",URL="group__nanoflann__grp.html"];
145  }
146 
147  nav [label="mrpt-nav",URL="group__mrpt__nav__grp.html"];
148  nav -> kinematics;
149  nav -> maps;
150 
151  obs [label="mrpt-obs",URL="group__mrpt__obs__grp.html"];
152  obs -> opengl;
153  obs -> db;
154  obs -> tfest;
155 
156  opengl [label="mrpt-opengl", URL="group__mrpt__opengl__grp.html"];
157  opengl -> poses;
158  opengl -> img;
159 
160  pbmap [label="mrpt-pbmap",URL="group__mrpt__pbmap__grp.html"];
161  pbmap -> graphs;
162 
163  poses [label="mrpt-poses",URL="group__mrpt__poses__grp.html"];
164  poses -> bayes;
165 
166  { rank = sink;
167  random [label="mrpt-random",URL="group__mrpt__random__grp.html"];
168  }
169 
170  rtti [label="mrpt-rtti",URL="group__mrpt__rtti__grp.html"];
171  rtti -> core;
172  rtti -> typemeta;
173 
174  serialization [label="mrpt-serialization",URL="group__mrpt__serialization__grp.html"];
175  serialization -> rtti;
176 
177  slam [label="mrpt-slam",URL="group__mrpt__slam__grp.html"];
178  slam -> maps;
179  slam -> vision;
180 
181  system [label="mrpt-system",URL="group__mrpt__system__grp.html"];
182  system -> typemeta;
183  system -> containers;
184 
185  tfest [label="mrpt-tfest",URL="group__mrpt__tfest__grp.html"];
186  tfest -> poses;
187 
188  topography [label="mrpt-topography",URL="group__mrpt__topography__grp.html"];
189  topography -> obs;
190 
191  { rank = sink;
192  typemeta [label="mrpt-typemeta (.h)",URL="group__mrpt__typemeta__grp.html"];
193  }
194 
195  vision [label="mrpt-vision",URL="group__mrpt__vision__grp.html"];
196  vision -> obs;
197 }
198 
199 \enddot
200 </div>
201 
202 Read also <a href=http://www.mrpt.org/Libraries_tree_layout >the guide</a> to write new MRPT libraries.
203 
204 <br><a name=dependencies>
205 <h2>Dependencies</h2>
206 
207 Check out <a href=dependencies.html >this page</a> to find out what are needed for each of the MRPT build dependencies (opencv, wxWidgets,...)
208 to decide if you need them for your applications.
209 
210 
211 
212 <br><a name=perf>
213 <h2>Performance benchmarks</h2>
214 
215 Extensive performance tests are automated by means of the application mrpt-performance.
216 To see the results on different platforms, as well as a comparison between different
217 compilers and platforms, see the <a href=perf-html/index.html> performance page</a>.
218 
219 
220 */
221 
222 
223 


Page generated by Doxygen 1.8.17 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at mié 12 jul 2023 10:03:34 CEST