TaoTermSetParametersSizes

Set the sizes describing the layout of the parameter vector space of a TaoTerm.

Synopsis

#include "petsctao.h" 
PetscErrorCode TaoTermSetParametersSizes(TaoTerm term, PetscInt k, PetscInt K, PetscInt bs)

Logically collective

Input Parameters

• term - a TaoTerm

• k - the size of a parameter vector on the current MPI process (or PETSC_DECIDE)

• K - the global size of a parameter vector (or PETSC_DECIDE)

• bs - the block size of a parameter vector (must be >= 1)

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 TaoTermSetParametersLayout() or TaoTermSetParametersTemplate() to define the vector sizes.

See Also

TaoTerm: composable objective function terms, TaoTerm, TaoTermGetParametersSizes(), TaoTermSetParametersTemplate(), TaoTermGetParametersVecType(), TaoTermSetParametersVecType(), TaoTermGetParametersLayout(), TaoTermSetParametersLayout(), TaoTermCreateParametersVec()

Level

beginner

Location

src/tao/term/interface/taoterm.c

Examples

src/tao/term/tutorials/ex1.c

---

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