Skip to content

Commit bf22798

Browse files
committed
Adding documentation examples for NonlinearObjectiveFunction.
Updates: - accord-netGH-195: Delegate functions
1 parent 4667a4c commit bf22798

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

Sources/Accord.Math/Optimization/NonlinearObjectiveFunction.cs

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,29 @@ namespace Accord.Math.Optimization
2929
using Accord.Compat;
3030

3131
/// <summary>
32-
/// Quadratic objective function.
32+
/// Nonlinear objective function.
3333
/// </summary>
3434
///
35+
/// <example>
36+
/// <para>
37+
/// In this framework, it is possible to state a non-linear programming problem
38+
/// using either symbolic processing or vector-valued functions. The following
39+
/// example demonstrates the symbolic processing case:</para>
40+
///
41+
/// <code source="Unit Tests\Accord.Tests.Math\Optimization\AugmentedLagrangianTest.cs" region="doc_lambda"/>
42+
///
43+
/// <para>
44+
/// And this is the same example as before, but using standard vectors instead.</para>
45+
///
46+
/// <code source="Unit Tests\Accord.Tests.Math\Optimization\AugmentedLagrangianTest.cs" region="doc_vector"/>
47+
/// </example>
48+
///
49+
/// <seealso cref="NelderMead"/>
50+
/// <seealso cref="Cobyla"/>
51+
/// <seealso cref="Subplex"/>
52+
/// <seealso cref="AugmentedLagrangian"/>
53+
/// <seealso cref="BroydenFletcherGoldfarbShanno"/>
54+
///
3555
public class NonlinearObjectiveFunction : IObjectiveFunction
3656
{
3757

0 commit comments

Comments
 (0)