From 0c6924ff244e96a32708c68e863021408e288e59 Mon Sep 17 00:00:00 2001 From: davidkep Date: Thu, 24 Oct 2019 19:54:06 -0700 Subject: [PATCH] clean up index and overview --- inst/doc/index.rst | 10 +--------- inst/doc/overview.rst | 15 ++++++++++----- 2 files changed, 11 insertions(+), 14 deletions(-) diff --git a/inst/doc/index.rst b/inst/doc/index.rst index 69910cf..88f43bb 100644 --- a/inst/doc/index.rst +++ b/inst/doc/index.rst @@ -4,15 +4,7 @@ API Documentation for nsoptim ############################# -Algorithms and utilities to optimize non-smooth functions, i.e., to solve - -.. math:: - \operatorname*{arg\,min}_{x} l(x) + p(x) - -where :math:`l(x)` is a smooth function called *loss function* and :math:`p(x)` is a non-smooth function, called *penalty function*. -The argument :math:`x` ise the *coefficient*, and the result of any optimization is the *optimum*. - -The library makes extensive use of templating to avoid dynamic polymorphism and improve runtime performance. +nsoptim is a C++ template library for non-smooth optimization, building upon the `armadillo `_ library for linear algebra. .. toctree:: :maxdepth: 4 diff --git a/inst/doc/overview.rst b/inst/doc/overview.rst index 1cfd692..abbf06f 100644 --- a/inst/doc/overview.rst +++ b/inst/doc/overview.rst @@ -2,12 +2,17 @@ Overview ######## -Algorithms and utilities to optimize non-smooth functions, i.e., to solve +The library porvides algorithms and utilities to optimize non-smooth functions, i.e., to solve .. math:: - \operatorname*{arg\,min}_{x} l(x) + p(x) + \operatorname*{arg\,min}_{x} l(x) + \phi(x) -where :math:`l(x)` is a smooth function called *loss function* and :math:`p(x)` is a non-smooth function, called *penalty function*. -The argument :math:`x` ise the *coefficient*, and the result of any optimization is the *optimum*. +where :math:`l(x)` is a smooth function (called *loss function*) and :math:`\phi(x)` is a non-smooth function (called *penalty function*). +The argument :math:`x` is the *coefficient*, and the result of any optimization is the *optimum*. + +************************************ +Dependencies and System Requirements +************************************ + +The library requires at least a C++ compiler compatible with C++ 11 and an installation of the `armadillo `_ library for linear algebra. -The library makes extensive use of templating to avoid dynamic polymorphism and improve runtime performance. \ No newline at end of file -- 2.22.0