TaoTermSumGetTermMask

Get the TaoTermMask of a term in the sum

Synopsis

#include "petsctao.h" 
PetscErrorCode TaoTermSumGetTermMask(TaoTerm term, PetscInt index, TaoTermMask *mask)

Not collective

Input Parameters

• term - a TaoTerm of type TAOTERMSUM

• index - the index for the term from TaoTermSumSetTerm() or TaoTermSumAddTerm()

Output Parameter

• mask - a bitmask of TaoTermMask evaluation methods to mask (e.g. just TAOTERM_MASK_OBJECTIVE or a bitwise-or like TAOTERM_MASK_OBJECTIVE | TAOTERM_MASK_GRADIENT)

See Also

TaoTerm: composable objective function terms, TaoTerm, TAOTERMSUM, TaoTermSumSetTermMask()

Level

developer

Location

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

Implementations

TaoTermSumGetTermMask_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