Skip to content

Commit

Permalink
add missing documentation for cutest_noobj
Browse files Browse the repository at this point in the history
rename incorrectly suffixed genc file
  • Loading branch information
dalekopera committed Dec 12, 2023
1 parent 16c19c4 commit 07f6e32
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 0 deletions.
3 changes: 3 additions & 0 deletions man/man3/cutest.3
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,9 @@ Constrained problems:
.B cutest_cdimen \fP(both threaded and unthreaded)
determine the number of variables and constraints.
.TP
.B cutest_cnoobj \fP(both threaded and unthreaded)
determine if the problem has an objective function
.TP
.B cutest_csetup \fP(unthreaded) and \fBcutest_csetup_threaded \fP(threaded)
setup internal data structures and determine variable and constraint bounds.
.TP
Expand Down
97 changes: 97 additions & 0 deletions man/man3/cutest_cnoobj.3
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
'\" e @(#)cutest_cnoobj v1.0 12/2012;
.TH cutest_cnoobj 3M "4 Dec 2012" "CUTEst user documentation" "CUTEst user documentation"
.SH NAME
CUTEST_cnoobj \- CUTEst tool to determine whether the problem has an
objective function or not.

.SH SYNOPSIS
.HP 1i
CALL CUTEST_cnoobj( status, input, noobj )

.HP 1i
For real rather than double precision arguments, instead

.HP 1i
CALL CUTEST_cnoobj_s( ... )
.SH DESCRIPTION
The CUTEST_cnoobj subroutine discovers whether the problem decoded
from a SIF file by the script
\fIsifdecoder\fP.
has an objective function or not.

The problem under consideration
is to minimize or maximize an objective function
.EQ
f(x)
.EN
over all
.EQ
x
.EN
\(mo
.EQ
R sup n
.EN
subject to
general equations
.EQ
c sub i (x) ~=~ 0,
.EN
.EQ
~(i
.EN
\(mo
.EQ
{ 1 ,..., m sub E } ),
.EN
general inequalities
.EQ
c sub i sup l ~<=~ c sub i (x) ~<=~ c sub i sup u,
.EN
.EQ
~(i
.EN
\(mo
.EQ
{ m sub E + 1 ,..., m }),
.EN
and simple bounds
.EQ
x sup l ~<=~ x ~<=~ x sup u.
.EN
The objective function is group-partially separable and all
constraint functions are partially separable.

.SH ARGUMENTS
The arguments of CUTEST_cnoobj are as follows
.TP 5
.B status \fP[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,
.TP
.B input \fP[in] - integer
the unit number for the decoded data; the unit from which OUTSDIF.d is
read,
.TP
.B noobj \fP[out] - logical
is there an objective function( .FALSE.) or not (.TRUE.)?
.LP
.SH AUTHORS
I. Bongartz, A.R. Conn, N.I.M. Gould, D. Orban and Ph.L. Toint
.SH "SEE ALSO"
\fICUTEst: a Constrained and Unconstrained Testing
Environment with safe threads\fP,
N.I.M. Gould, D. Orban and Ph.L. Toint,
Computational Optimization and Applications \fB60\fP:3, pp.545-557, 2014.

\fICUTEr (and SifDec): A Constrained and Unconstrained Testing
Environment, revisited\fP,
N.I.M. Gould, D. Orban and Ph.L. Toint,
ACM TOMS, \fB29\fP:4, pp.373-394, 2003.

\fICUTE: Constrained and Unconstrained Testing Environment\fP,
I. Bongartz, A.R. Conn, N.I.M. Gould and Ph.L. Toint,
ACM TOMS, \fB21\fP:1, pp.123-160, 1995.

sifdecoder(1).
File renamed without changes.

0 comments on commit 07f6e32

Please sign in to comment.