TaoTermCreateParametersVec

Create a parameter vector for a TaoTerm

Synopsis

#include "petsctao.h" 
PetscErrorCode TaoTermCreateParametersVec(TaoTerm term, Vec *parameters)

Collective

Input Parameter

• term - a TaoTerm

Output Parameter

• parameters - a compatible parameter vector for term

Notes

Before a TaoTerm can create a parameter vector, you must do one of the following:

• Call TaoTermSetParametersSizes() to describe the size and parallel layout of a parameters vector.

• Call TaoTermSetParametersLayout() to directly set PetscLayouts for the parameters vector.

• Call TaoTermSetParametersTemplate() to set the parameters vector spaces to match existing Vec.

• If the TaoTerm is a TAOTERMSHELL, you can call TaoTermShellSetCreateParametersVec() to use your own code for creating vectors.

You can also call TaoTermSetParametersVecType() to set the type of vector created (e.g. VECCUDA).

See Also

TaoTerm: composable objective function terms, TaoTerm, TaoTermShellSetCreateParametersVec(), TaoTermGetParametersSizes(), TaoTermSetParametersSizes(), TaoTermSetParametersTemplate(), TaoTermGetParametersVecType(), TaoTermSetParametersVecType(), TaoTermGetParametersLayout(), TaoTermSetParametersLayout(), TaoTermCreateHessianMatrices()

Level

advanced

Location

src/tao/term/interface/taoterm.c

Implementations

TaoTermCreateParametersVec_Test() in src/tao/term/impls/shell/tests/ex1.c
TaoTermCreateParametersVec_Sum() in src/tao/term/impls/sum/taotermsum.c

---

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