Add man page as core documentation

The man pages on `$CUTEST/man/man3` were converted to html
with mdocml and then to plain text with pandoc.

docs/ccfg.txt

@@ -0,0 +1,104 @@
+  ----------------- --------------------------- -----------------
+  cutest_ccfg(3M)   CUTEst user documentation   cutest_ccfg(3M)
+  ----------------- --------------------------- -----------------
+
+NAME
+
+CUTEST_ccfg - CUTEst tool to evaluate constraint functions values and
+possibly gradients.
+
+SYNOPSIS
+
+CALL CUTEST_ccfg( status, n, m, X, C, jtrans, lj1, lj2, J_val, grad )
+
+DESCRIPTION
+
+The CUTEST_ccfg subroutine evaluates the values of the constraint
+functions of the problem decoded from a SIF file by the script
+_sifdecoder_ at the point X, and possibly their gradients. The problem
+under consideration is to minimize or maximize an objective function
+f(x) over all x ∈ Rn subject to general equations ci(x)=0, ~(i ∈
+1,...,mE), general inequalities cil(x)≤ci(x)≤ciu(x), ~(i ∈ mE+1,...,m),
+and simple bounds xl≤x≤xu. The objective function is group-partially
+separable and all constraint functions are partially separable.
+
+ARGUMENTS
+
+The arguments of CUTEST_ccfg are as follows
+
+ STATUS _[OUT] - INTEGER_
+    the outputr status: 0 for a succesful call, 1 for an array
+    allocation/deallocation error, 2 for an array bound error, 3 for an
+    evaluation error,
+
+ N _[IN] - INTEGER_
+    the number of variables for the problem,
+
+ M _[IN] - INTEGER_
+    the total number of general constraints,
+
+ X _[IN] - REAL/DOUBLE PRECISION_
+    an array which gives the current estimate of the solution of the
+    problem,
+
+ C _[OUT] - REAL/DOUBLE PRECISION_
+    an array which gives the values of the general constraint functions
+    evaluated at X. The i-th component of C will contain the value of
+    ci(x),
+
+ JTRANS _[IN] - LOGICAL_
+    a logical variable which should be set .TRUE. if the transpose of
+    the constraint Jacobian is required and .FALSE. if the Jacobian
+    itself is wanted. The Jacobian matrix is the matrix whose i-th row
+    is the gradient of the i-th constraint function,
+
+ LJ1 _[IN] - INTEGER_
+    the actual declared size of the leading dimension of J_val (with lj1
+    no smaller than n if jtrans is .TRUE. or m if jtrans is .FALSE.),
+
+ LJ2 _[IN] - INTEGER_
+    the actual declared size of the second dimension of J_val (with lj2
+    no smaller than m if jtrans is .TRUE. or n if jtrans is .FALSE.),
+
+ J_VAL _[OUT] - REAL/DOUBLE PRECISION_
+    a two-dimensional array of dimension (lj1, lj2) which gives the
+    value of the Jacobian matrix of the constraint functions, or its
+    transpose, evaluated at X. If jtrans is .TRUE., the i,j-th component
+    of the array will contain the i-th derivative of the j-th constraint
+    function. Otherwise, if jtrans is .FALSE., the i,j-th component of
+    the array will contain the j-th derivative of the i-th constraint
+    function,
+
+ GRAD _[IN] - LOGICAL_
+    a logical variable which should be set .TRUE. if the gradient of the
+    constraint functions are required and .FALSE. otherwise.
+
+AUTHORS
+
+I. Bongartz, A.R. Conn, N.I.M. Gould, D. Orban and Ph.L. Toint
+
+SEE ALSO
+
+_CUTEst: a Constrained and Unconstrained Testing_ _Environment with safe
+threads_,
+ N.I.M. Gould, D. Orban and Ph.L. Toint,
+ Technical Report, Rutherford Appleton Laboratory, 2013.
+
+
+_CUTEr (and SifDec): A Constrained and Unconstrained Testing_
+_Environment, revisited_,
+ N.I.M. Gould, D. Orban and Ph.L. Toint,
+ ACM TOMS, 29:4, pp.373-394, 2003.
+
+
+_CUTE: Constrained and Unconstrained Testing Environment_, I. Bongartz,
+A.R. Conn, N.I.M. Gould and Ph.L. Toint, ACM TOMS, 21:1, pp.123-160,
+1995.
+
+
+sifdecoderr(1)
+
+  ------------ ---------------------------
+  4 Dec 2012   CUTEst user documentation
+  ------------ ---------------------------
+

docs/ccfsg.txt

@@ -0,0 +1,110 @@
+  ------------------ --------------------------- ------------------
+  cutest_ccfsg(3M)   CUTEst user documentation   cutest_ccfsg(3M)
+  ------------------ --------------------------- ------------------
+
+NAME
+
+CUTEST_ccfsg - CUTEst tool to evaluate constraint functions values and
+possibly their gradients in sparse format.
+
+SYNOPSIS
+
+CALL CUTEST_ccfsg( status, n, m, X, C, nnzj, lj, J_val, J_var, J_fun,
+grad )
+
+DESCRIPTION
+
+The CUTEST_ccfsg subroutine evaluates the values of the constraint
+functions of the problem decoded from a SIF file by the script
+_sifdecoder_ at the point X, and possibly their gradients in the
+constrained minimization case. The gradients are stored in sparse
+format.
+
+
+The problem under consideration is to minimize or maximize an objective
+function f(x) over all x ∈ Rn subject to general equations ci(x)=0, ~(i
+∈ 1,...,mE), general inequalities cil(x)≤ci(x)≤ciu(x), ~(i ∈
+mE+1,...,m), and simple bounds xl≤x≤xu. The objective function is
+group-partially separable and all constraint functions are partially
+separable.
+
+
+ARGUMENTS
+
+The arguments of CUTEST_ccfsg are as follows
+
+ STATUS _[OUT] - INTEGER_
+    the outputr status: 0 for a succesful call, 1 for an array
+    allocation/deallocation error, 2 for an array bound error, 3 for an
+    evaluation error,
+
+ N _[IN] - INTEGER_
+    the number of variables for the problem,
+
+ M _[IN] - INTEGER_
+    the total number of general constraints,
+
+ X _[IN] - REAL/DOUBLE PRECISION_
+    an array which gives the current estimate of the solution of the
+    problem,
+
+ C _[OUT] - REAL/DOUBLE PRECISION_
+    an array which gives the values of the general constraint functions
+    evaluated at X. The i-th component of C will contain the value of
+    ci(x).
+
+ NNZJ _[OUT] - INTEGER_
+    the number of nonzeros in J_val,
+
+ LJ _[IN] - INTEGER_
+    the actual declared dimensions of J_val, J_var and J_fun,
+
+ J_VAL _[OUT] - REAL/DOUBLE PRECISION_
+    an array which gives the values of the nonzeros of the general
+    constraint functions evaluated at X. The i-th entry of J_val gives
+    the value of the derivative with respect to variable J_var(i) of
+    constraint function J_fun(i),
+
+ J_VAR _[OUT] - INTEGER_
+    an array whose i-th component is the index of the variable with
+    respect to which J_val(i) is the derivative,
+
+ J_FUN _[OUT] - INTEGER_
+    an array whose i-th component is the index of the problem function
+    of which J_val(i) is the derivative,
+
+ GRAD _[IN] - LOGICAL_
+    a logical variable which should be set .TRUE. if the gradient of the
+    constraint functions are required and .FALSE. otherwise.
+
+AUTHORS
+
+I. Bongartz, A.R. Conn, N.I.M. Gould, D. Orban and Ph.L. Toint
+
+SEE ALSO
+
+_CUTEst: a Constrained and Unconstrained Testing_ _Environment with safe
+threads_,
+ N.I.M. Gould, D. Orban and Ph.L. Toint,
+ Technical Report, Rutherford Appleton Laboratory, 2013.
+
+
+_CUTEr (and SifDec): A Constrained and Unconstrained Testing_
+_Environment, revisited_,
+ N.I.M. Gould, D. Orban and Ph.L. Toint,
+ ACM TOMS, 29:4, pp.373-394, 2003.
+
+
+_CUTE: Constrained and Unconstrained Testing Environment_, I. Bongartz,
+A.R. Conn, N.I.M. Gould and Ph.L. Toint, ACM TOMS, 21:1, pp.123-160,
+1995.
+
+
+
+
+sifdecoder(1)
+
+  ------------ ---------------------------
+  4 Dec 2012   CUTEst user documentation
+  ------------ ---------------------------
+

docs/ccifg.txt

@@ -0,0 +1,85 @@
+  ------------------ --------------------------- ------------------
+  cutest_ccifg(3M)   CUTEst user documentation   cutest_ccifg(3M)
+  ------------------ --------------------------- ------------------
+
+NAME
+
+CUTEST_ccifg - CUTEst tool to evaluate a single constraint function
+value and possibly its gradient.
+
+SYNOPSIS
+
+CALL CUTEST_ccifg( status, n, icon, X, ci, GCI_val, grad )
+
+DESCRIPTION
+
+The CUTEST_ccifg subroutine evaluates the value of a particular
+constraint function of the problem decoded from a SIF file by the script
+_sifdecoder_ at the point X, and possibly its gradient in the
+constrained minimization case. The problem under consideration is to
+minimize or maximize an objective function f(x) over all x ∈ Rn subject
+to general equations ci(x)=0, ~(i ∈ 1,...,mE), general inequalities
+cil(x)≤ci(x)≤ciu(x), ~(i ∈ mE+1,...,m), and simple bounds xl≤x≤xu. The
+objective function is group-partially separable and all constraint
+functions are partially separable.
+
+
+ARGUMENTS
+
+The arguments of CUTEST_ccifg are as follows
+
+ STATUS _[OUT] - INTEGER_
+    the outputr status: 0 for a succesful call, 1 for an array
+    allocation/deallocation error, 2 for an array bound error, 3 for an
+    evaluation error,
+
+ N _[IN] - INTEGER_
+    the number of variables for the problem,
+
+ ICON _[IN] - INTEGER_
+    the index of the constraint function to be evaluated,
+
+ X _[IN] - REAL/DOUBLE PRECISION_
+    an array which gives the current estimate of the solution of the
+    problem,
+
+ CI _[OUT] - REAL/DOUBLE PRECISION_
+    the value of constraint function icon at X,
+
+ GCI_VAL _[OUT] - REAL/DOUBLE PRECISION_
+    an array which gives the gradient of constraint function icon
+    evaluated at X,
+
+ GRAD _[IN] - LOGICAL_
+    a logical variable which should be set .TRUE. if the gradient of the
+    constraint functions are required and .FALSE. otherwise.
+
+AUTHORS
+
+I. Bongartz, A.R. Conn, N.I.M. Gould, D. Orban and Ph.L. Toint
+
+SEE ALSO
+
+_CUTEst: a Constrained and Unconstrained Testing_ _Environment with safe
+threads_,
+ N.I.M. Gould, D. Orban and Ph.L. Toint,
+ Technical Report, Rutherford Appleton Laboratory, 2013.
+
+
+_CUTEr (and SifDec): A Constrained and Unconstrained Testing_
+_Environment, revisited_,
+ N.I.M. Gould, D. Orban and Ph.L. Toint,
+ ACM TOMS, 29:4, pp.373-394, 2003.
+
+
+_CUTE: Constrained and Unconstrained Testing Environment_, I. Bongartz,
+A.R. Conn, N.I.M. Gould and Ph.L. Toint, ACM TOMS, 21:1, pp.123-160,
+1995.
+
+
+sifdecoder(1)
+
+  ------------ ---------------------------
+  4 Dec 2012   CUTEst user documentation
+  ------------ ---------------------------
+