aboutsummaryrefslogtreecommitdiffstats
path: root/methods
diff options
context:
space:
mode:
Diffstat (limited to 'methods')
-rw-r--r--methods/gsl_simplex/gsl_simplex.hpp16
-rw-r--r--methods/powell/powell_method.hpp20
2 files changed, 22 insertions, 14 deletions
diff --git a/methods/gsl_simplex/gsl_simplex.hpp b/methods/gsl_simplex/gsl_simplex.hpp
index 9c094b0..d2071c8 100644
--- a/methods/gsl_simplex/gsl_simplex.hpp
+++ b/methods/gsl_simplex/gsl_simplex.hpp
@@ -1,3 +1,7 @@
+/**
+ \file gsl_simplex.hpp
+ */
+
#ifndef GSL_SIMPLEX_METHOD
#define GSL_SIMPLEX_METHOD
#include <core/optimizer.hpp>
@@ -8,14 +12,15 @@
#include <cmath>
#include <algorithm>
#include <gsl_multimin.h>
-/*
- *
-*/
#include <iostream>
namespace opt_utilities
{
+
+ /**
+ object function of the gsl simplex function
+ */
template <typename rT,typename pT>
double gsl_func_adapter(const gsl_vector* v,void* params)
{
@@ -29,6 +34,11 @@ namespace opt_utilities
}
+ /**
+ wrapper for the gsl simplex optimization method
+ \tparam return type of the object function
+ \tparam param type of the object function
+ */
template <typename rT,typename pT>
class gsl_simplex
:public opt_method<rT,pT>
diff --git a/methods/powell/powell_method.hpp b/methods/powell/powell_method.hpp
index 6424a94..6bb6519 100644
--- a/methods/powell/powell_method.hpp
+++ b/methods/powell/powell_method.hpp
@@ -1,3 +1,7 @@
+/**
+ \file powell_method.hpp
+ */
+
#ifndef POWELL_METHOD
#define POWELL_METHOD
#include <core/optimizer.hpp>
@@ -7,21 +11,15 @@
#include <cmath>
#include "linmin.hpp"
#include <algorithm>
-/*
- *
-*/
#include <iostream>
namespace opt_utilities
{
- /*
- template <typename T>
- T tabs(T x)
- {
- return x<0?-x:x;
- }
- */
-
+ /**
+ Impliment of an optimization method
+ \tparam rT return type of the object function
+ \tparam pT parameter type of the object function
+ */
template <typename rT,typename pT>
class powell_method
:public opt_method<rT,pT>