Skip to content

Commit

Permalink
Added doc skeleton
Browse files Browse the repository at this point in the history
  • Loading branch information
cassinaj committed Oct 9, 2015
1 parent f43ea37 commit 11cdc38
Show file tree
Hide file tree
Showing 8 changed files with 3,155 additions and 0 deletions.
2,353 changes: 2,353 additions & 0 deletions doc/Doxyfile.in

Large diffs are not rendered by default.

62 changes: 62 additions & 0 deletions doc/bibliography.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
% This file was created with JabRef 2.7b.
% Encoding: UTF-8
@ARTICLE{barry2000approximation,
author = {Barry, DA and Parlange, J-Y and Li, L},
title = {Approximation for the exponential integral (Theis well function)},
journal = {Journal of Hydrology},
year = {2000},
volume = {227},
pages = {287--291},
number = {1},
publisher = {Elsevier}
}

@ARTICLE{giles2010approximating,
author = {Giles, Mike},
title = {Approximating the erfinv function},
journal = {GPU Gems},
year = {2010},
volume = {4}
}

@ARTICLE{matsumoto1998mersenne,
author = {Matsumoto, Makoto and Nishimura, Takuji},
title = {Mersenne twister: a 623-dimensionally equidistributed uniform pseudo-random
number generator},
journal = {ACM Transactions on Modeling and Computer Simulation (TOMACS)},
year = {1998},
volume = {8},
pages = {3--30},
number = {1},
publisher = {ACM}
}

@BOOK{press2007numerical,
title = {Numerical recipes 3rd edition: The art of scientific computing},
publisher = {Cambridge university press},
year = {2007},
author = {Press, William H}
}

@INPROCEEDINGS{wan2000unscented,
author = {Wan, Eric A and Van Der Merwe, Rudolph},
title = {The unscented Kalman filter for nonlinear estimation},
booktitle = {Adaptive Systems for Signal Processing, Communications, and Control
Symposium 2000. AS-SPCC. The IEEE 2000},
year = {2000},
pages = {153--158},
organization = {IEEE}
}

@ARTICLE{wu2006numerical,
author = {Wu, Yuanxin and Hu, Dewen and Wu, Meiping and Hu, Xiaoping},
title = {A numerical-integration perspective on Gaussian filters},
journal = {Signal Processing, IEEE Transactions on},
year = {2006},
volume = {54},
pages = {2910--2921},
number = {8},
publisher = {IEEE}
}

64 changes: 64 additions & 0 deletions doc/mainpage.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@

namespace fl
{

/**

\mainpage notitle

\tableofcontents

\section about_fl About FL (draft)

FL is general purpose C++ ([C++11](http://en.wikipedia.org/wiki/C%2B%2B11)
standard) Bayesian filtering framework library with real-time support for
linear and non-linear systems. Currently available filters are (just an
example list)


- General Particle Filter
- Coordinate Particle Filter
- KalmanFilter for purely linear systems
- Sigma Point Kalman Filter for linear and non-linear systems


The library is being developed as an extensible framework with low application
restrictions.

The employed underlying concepts are aimed to use this library in
regular offline mode applications as well as in real-time systems. As a result
of the real-time capability, the user has the option to take advantage of
vectorization optimizations (SEE2, SSE3 or SSE4, AltiVec, ARM NEON) and zero
runtime heap allocation all together with minimum effort.

\section dependecies Dependencies and Compiling

FL doesn't require pre-complication nor any library linking. The entire code
base is generic and based on templates.

The library dependencies are

- Eigen3 ([Eigen 3.1.2 or higher](http://eigen.tuxfamily.org/))

To be able to compile your code with FL you need to enable the C++11 or C++0x
standard for your compiler. With GCC you may add the definition

-std=c++0x OR -std=c++11

\subsection tested_eigen Tested Eigen3

- Eigen 3.1.2
- Eigen 3.2.0

\subsection tested_compilers Tested Compilers

- GCC 4.6 (-std=c++0x)
- GCC 4.8 (-std=c++11)

\subsection tested_os Tested OS

- Ubuntu 12.04 LTS (Precise (AMD64))
- Ubuntu 14.04 LTS (Trusty Tahr (AMD64))
*/

}
40 changes: 40 additions & 0 deletions doc/modules.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@

namespace fl
{

/**
\defgroup filters Filter Algorithms
\defgroup distributions Distributions
\defgroup observation_models Observation Models
\defgroup process_models Process Models
\defgroup numeric_integration Numeric Integration

\defgroup traits Traits
\defgroup meta Meta
\defgroup math Math
\defgroup types Types
\defgroup util Util
\defgroup exceptions Exceptions
*/

/**
* \defgroup distribution_interfaces Interfaces
* \ingroup distributions
*/

/**
* \defgroup special_functions Special Functions
* \ingroup math
*/

/**
* \defgroup general_functions General Functions
* \ingroup math
*/

/**
* \defgroup linear_algebra Linear Algebra
* \ingroup math
*/

}
133 changes: 133 additions & 0 deletions doc/theme/customization.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
div.contents
{
max-width:55em;
}

p, dl.warning, dl.attention, dl.note
{
text-align:justify;
}

li {
text-align:justify;
}

div.fragment {
display: table;
}

table.doxtable, table.example th, table.manual th, table.manual-vl th {
padding: 0.5em 0.5em 0.5em 0.5em;
text-align: left;
padding-right: 1em;
color: #555555;
background-color: #F4F4E5;

background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.3,#FFFFFF), color-stop(0.30,#FFFFFF), color-stop(0.98,#F4F4E5), to(#ECECDE));
background-image: -moz-linear-gradient(center top, #FFFFFF 0%, #FFFFFF 30%, #F4F4E5 98%, #ECECDE);
filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#FFFFFF', endColorstr='#F4F4E5');
}

table.doxtable td, table.example td, table.manual td, table.manual-vl td {
vertical-align:top;
border-width: 1px;
border-color: #cccccc;
}

table.tparams td
{
vertical-align:top;
}


h2 {
margin-top:2em;
border-style: none none solid none;
border-width: 1px;
border-color: #cccccc;
}

div.toc {
width:40%;
margin-right:0;
}

/* @group Code Colorization */

span.keyword {
color: #a71d5d;

}

span.keywordtype {
color: #b58900
}

span.keywordflow {
color: #e08000
}

span.comment {
color: #969896
}

span.preprocessor {
color: #6c71c4
}

span.stringliteral {
color: #2aa198
}

span.charliteral {
color: #008080
}

span.concept {
color: #795da3;
}

span.traits {
font-weight: bold;
}

span.doccommand {
color: #2aa198;
}

span.function {
color: #0086b3;
}

span.staticfunction {
color: #800000;
}

div.fragment {
color: #333;
font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
font-size: 12px;
font-style: normal;
font-variant: normal;
font-weight: normal;
line-height: 16.7999992370605px;

width: 100%;
padding: 0 0 0 0;
margin: 0 0 0 0;
background-color: #FFFFFF;
border: 1px solid #C4CFE5;
}

div.line{
color: #333;
font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
font-size: 12px;
font-style: normal;
font-variant: normal;
font-weight: normal;
line-height: 16.7999992370605px;
}


/* @end */
Loading

0 comments on commit 11cdc38

Please sign in to comment.