Skip to content

Commit 270b768

Browse files
committed
added minimisers to reference
1 parent 3b0d0d7 commit 270b768

File tree

7 files changed

+65
-0
lines changed

7 files changed

+65
-0
lines changed

source/reference/matlab/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@ MATLAB API Reference
1010
controlClass
1111
entryFunctions
1212
targetFunctions
13+
minimisers/index
1314
plotting
1415
utilities
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Differential Evolution
2+
----------------------
3+
4+
See :ref:`DE` for information on differential evolution.
5+
6+
.. default-domain:: mat
7+
.. automodule:: minimisers.DE
8+
:members:
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
DREAM
2+
-----
3+
4+
See :ref:`DREAM` for information on DREAM.
5+
6+
.. default-domain:: mat
7+
.. automodule:: minimisers.DREAM
8+
:members:
9+
10+
.. automodule:: minimisers.DREAM.functions
11+
:members:
12+
13+
.. automodule:: minimisers.DREAM.postprocessing
14+
:members:
15+
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
General Minimiser Utilities
2+
---------------------------
3+
4+
General utilities used by the minimisers.
5+
6+
.. default-domain:: mat
7+
.. automodule:: minimisers.generalUtils
8+
:members:
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Minimisers
2+
----------
3+
4+
This submodule contains the minimisation algorithms used to optimise
5+
a model.
6+
7+
For explanatory information on the minimisation algorithms,
8+
see the :ref:`algorithms section of the documentation<algorithms>`.
9+
10+
.. toctree::
11+
:maxdepth: 1
12+
13+
simplex
14+
de
15+
ns
16+
dream
17+
generalUtils
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Nested Sampling
2+
---------------
3+
4+
See :ref:`nestedSampling` for more information on nested sampling.
5+
6+
.. default-domain:: mat
7+
.. automodule:: minimisers.NS
8+
:members:
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Simplex
2+
-------
3+
4+
See :ref:`simplex` for more information on the Nelder-Mead Simplex method.
5+
6+
.. default-domain:: mat
7+
.. automodule:: minimisers.simplex
8+
:members:

0 commit comments

Comments
 (0)