OpenTURNS library  1.14dev
 All Classes Namespaces Files Functions Variables Typedefs Friends Pages
OpenTURNS API documentation

The internal header file of OpenTURNSCopyright 2005-2019 Airbus-EDF-IMACS-Phimeca

This library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library. If not, see http://www.gnu.org/licenses/.

This documentation is intented to be used by experienced programmers. It shows the API of almost all the objects defined by the C++ core library of OpenTURNS.

There may be undocumented features or objects. This is a mistake. You can help us improve the software by noticing us of these caveats or by documenting them yourself as a friendly user.

As visible either in the directory structure or in the namespace naming, the library is divided in two main pieces:

  • the Base part
  • the Uncertainty part

Base

The Base part of the library provides containers and algorithms of common usage, such as multidimensional points (Point), aka vectors, samples (Sample) or functions (Function). Every concept in OpenTURNS is multidimensional unless clearly expressed or documented.

Uncertainty

The Uncertainty part of the library provides objects and algorithms designed to achieve probabilistic analyses. Here you will find things like distributions (Distribution or Normal), random vectors (RandomVector), algorithms (FORM or MonteCarlo) or statistical tests (FittingTest).

As you will probably see, a particular attention was paid to precisely name classes and objects according to their usage. We hope this will help you enter the library.

The OpenTURNS core team.