TaoTermSumParametersPack

Concatenate the parameters for terms into a VECNEST parameter vector for a TAOTERMSUM

Synopsis

#include "petsctao.h" 
PetscErrorCode TaoTermSumParametersPack(TaoTerm term, Vec p_arr[], Vec *params)

Collective

Input Parameters

• term - a TaoTerm of type TAOTERMSUM

• p_arr - an array of parameters Vecs, one for each term in the sum. An entry can be NULL for a term that doesn’t take parameters.

Output Parameter

• params - a Vec of type VECNEST that concatenates all of the parameters

Note

This is a wrapper around VecCreateNest(), but that function does not allow NULL for any of the Vecs in the array. A 0-length vector will be created for each NULL Vec that will be internally ignored by TAOTERMSUM.

See Also

TaoTerm: composable objective function terms, TaoTerm, TAOTERMSUM, TaoTermSumParametersUnpack(), VECNEST, VecNestGetTaoTermSumParameters(), VecCreateNest()

Level

developer

Location

src/tao/term/impls/sum/taotermsum.c

---

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