TaoTermSetParametersTemplate#

Set the parameter vector space to match a template vector

Synopsis#

#include "petsctao.h" 
PetscErrorCode TaoTermSetParametersTemplate(TaoTerm term, Vec params_template)

Collective

Input Parameters#

  • term - a TaoTerm

  • params_template - a vector with the desired size, layout, and VecType of parameter vectors for TaoTerm

Notes#

The “parameter space” of a TaoTerm is the vector space of the fixed data \(p\) in \(f(x; p)\). Parameters are not optimized over. This is distinct from the “solution space” (set with TaoTermSetSolutionSizes()), which is the space of the optimization variable \(x\). Some TaoTermTypes require the solution and parameter spaces to be related (e.g., have the same size); see the documentation for each type.

Alternatively, one may use TaoTermSetParametersSizes() or TaoTermSetParametersLayout() to define the vector sizes.

See Also#

TaoTerm: composable objective function terms, TaoTerm, TaoTermGetParametersVecType(), TaoTermSetParametersVecType(), TaoTermSetSolutionTemplate(), TaoTermGetParametersLayout(), TaoTermSetParametersLayout(), TaoTermCreateSolutionVec()

Level#

intermediate

Location#

src/tao/term/interface/taoterm.c


Index of all TaoTerm routines
Table of Contents for all manual pages
Index of all manual pages