NLPInterfacePack_test_nlp_first_order.hpp File Reference

#include <iosfwd>
#include "NLPInterfacePack_Types.hpp"

Include dependency graph for NLPInterfacePack_test_nlp_first_order.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.


namespace  OptionsFromStreamPack
namespace  NLPInterfacePack


bool test_nlp_first_order (NLPFirstOrder *nlp, OptionsFromStreamPack::OptionsFromStream *options, std::ostream *out)
 Test an NLPFirstOrder object.

Function Documentation

bool NLPInterfacePack::test_nlp_first_order NLPFirstOrder *  nlp,
OptionsFromStreamPack::OptionsFromStream options,
std::ostream *  out

Test an NLPFirstOrder object.

nlp [in/out] NLP object being tested.
options [in] If options != NULL then the options to use are extracted from *options. If options == NULL then a default set of options will be used that will be appropriate for even the largest NLP (see below).
out [in/out] If out != NULL then output will be set to *out. The amount of output sent to *out depends on the options selected. If out == NULL then no output is produced.
This function uses the testing classes VectorSpaceTester NLPTester and NLPFirstOrderInfoTester to perform many through tests of an input NLPFirstOrder object. The vector spaces exposed by NLP are thoroughly tested by the VectorSpaceTester class.

The options groups "VectorSpaceTester" (see VectorSpaceTesterSetOptions), "%NLPTester" (see NLPTesterSetOptions), "%CalcFiniteDiffProd" (see CalcFiniteDiffProdSetOptions) and "%NLPFirstOrderInfoTester" (see NLPFirstOrderInfoTesterSetOptions) are looked for in in *options (if options != NULL) order to extract options to use for this testing function and the other testing objects.

Definition at line 49 of file NLPInterfacePack_test_nlp_first_order.cpp.

Generated on Thu Sep 18 12:35:58 2008 for MOOCHO (Single Doxygen Collection) by doxygen