impls/brgn/brgn.c

69 . tao - a `Tao` of type `TAOBRGN` with `TAOBRGN_REGULARIZATION_LM` regularization
76 .seealso: [](ch_tao), `Tao`, `TAOBRGN`, `TaoBRGNRegularzationTypes`
78 PetscErrorCode TaoBRGNGetDampingVector(Tao tao, Vec *d)
83   PetscUseMethod((PetscObject)tao, "TaoBRGNGetDampingVector_C", (Tao, Vec *), (tao, d));
87 static PetscErrorCode TaoBRGNGetDampingVector_BRGN(Tao tao, Vec *d)
97 static PetscErrorCode GNObjectiveGradientEval(Tao tao, Vec X, PetscReal *fcn, Vec G, void *ptr)
165 static PetscErrorCode GNComputeHessian(Tao tao, Vec X, Mat H, Mat Hpre, void *ptr)
221 static PetscErrorCode GNHookFunction(Tao tao, PetscInt iter, PetscCtx ctx)
264 static PetscErrorCode TaoBRGNGetRegularizationType_BRGN(Tao tao, TaoBRGNRegularizationType *type)
279 . tao - a `Tao` of type `TAOBRGN`
286 .seealso: [](ch_tao), `Tao`, `TAOBRGN`, `TaoBRGNRegularizationType`, `TaoBRGNSetRegularizationType()`
288 PetscErrorCode TaoBRGNGetRegularizationType(Tao tao, TaoBRGNRegularizationType *type)
293   PetscUseMethod((PetscObject)tao, "TaoBRGNGetRegularizationType_C", (Tao, TaoBRGNRegularizationType *), (tao, type));
297 static PetscErrorCode TaoBRGNSetRegularizationType_BRGN(Tao tao, TaoBRGNRegularizationType type)
312 + tao  - a `Tao` of type `TAOBRGN`
317 .seealso: [](ch_tao), `Tao`, `TAOBRGN`, `TaoBRGNRegularizationType`, `TaoBRGNGetRegularizationType`
319 PetscErrorCode TaoBRGNSetRegularizationType(Tao tao, TaoBRGNRegularizationType type)
324   PetscTryMethod((PetscObject)tao, "TaoBRGNSetRegularizationType_C", (Tao, TaoBRGNRegularizationType), (tao, type));
328 static PetscErrorCode TaoSolve_BRGN(Tao tao)
349 static PetscErrorCode TaoSetFromOptions_BRGN(Tao tao, PetscOptionItems PetscOptionsObject)
372 static PetscErrorCode TaoView_BRGN(Tao tao, PetscViewer viewer)
405 static PetscErrorCode TaoSetUp_BRGN(Tao tao)
479 static PetscErrorCode TaoDestroy_BRGN(Tao tao)
519 + tao       - the Tao solver context
520 - subsolver - the `Tao` sub-solver context
524 .seealso: `Tao`, `Mat`, `TAOBRGN`
526 PetscErrorCode TaoBRGNGetSubsolver(Tao tao, Tao *subsolver)
530   PetscUseMethod((PetscObject)tao, "TaoBRGNGetSubsolver_C", (Tao, Tao *), (tao, subsolver));
534 static PetscErrorCode TaoBRGNGetSubsolver_BRGN(Tao tao, Tao *subsolver)
549 + tao    - the `Tao` solver context
554 .seealso: `Tao`, `Mat`, `TAOBRGN`
556 PetscErrorCode TaoBRGNSetRegularizerWeight(Tao tao, PetscReal lambda)
561   PetscTryMethod((PetscObject)tao, "TaoBRGNSetRegularizerWeight_C", (Tao, PetscReal), (tao, lambda));
565 static PetscErrorCode TaoBRGNSetRegularizerWeight_BRGN(Tao tao, PetscReal lambda)
580 + tao     - the `Tao` solver context
585 .seealso: `Tao`, `Mat`, `TAOBRGN`
587 PetscErrorCode TaoBRGNSetL1SmoothEpsilon(Tao tao, PetscReal epsilon)
592   PetscTryMethod((PetscObject)tao, "TaoBRGNSetL1SmoothEpsilon_C", (Tao, PetscReal), (tao, epsilon));
596 static PetscErrorCode TaoBRGNSetL1SmoothEpsilon_BRGN(Tao tao, PetscReal epsilon)
609 + tao  - the `Tao` context
614 .seealso: `Tao`, `Mat`, `TAOBRGN`
616 PetscErrorCode TaoBRGNSetDictionaryMatrix(Tao tao, Mat dict)
620   PetscTryMethod((PetscObject)tao, "TaoBRGNSetDictionaryMatrix_C", (Tao, Mat), (tao, dict));
624 static PetscErrorCode TaoBRGNSetDictionaryMatrix_BRGN(Tao tao, Mat dict)
644 + tao  - the Tao context
649 + tao - the `Tao` context
657 .seealso: `Tao`, `Mat`, `TAOBRGN`
659 PetscErrorCode TaoBRGNSetRegularizerObjectiveAndGradientRoutine(Tao tao, PetscErrorCode (*func)(Tao tao, Vec u, PetscReal *val, Vec g, PetscCtx ctx), PetscCtx ctx)
663   PetscTryMethod((PetscObject)tao, "TaoBRGNSetRegularizerObjectiveAndGradientRoutine_C", (Tao, PetscErrorCode (*)(Tao, Vec, PetscReal *, Vec, void *), void *), (tao, func, ctx));
667 static PetscErrorCode TaoBRGNSetRegularizerObjectiveAndGradientRoutine_BRGN(Tao tao, PetscErrorCode (*func)(Tao tao, Vec u, PetscReal *val, Vec g, PetscCtx ctx), PetscCtx ctx)
682 + tao  - the `Tao` context
688 + tao  - the `Tao` context
695 .seealso: `Tao`, `Mat`, `TAOBRGN`
697 PetscErrorCode TaoBRGNSetRegularizerHessianRoutine(Tao tao, Mat Hreg, PetscErrorCode (*func)(Tao tao, Vec u, Mat Hreg, PetscCtx ctx), PetscCtx ctx)
701   PetscTryMethod((PetscObject)tao, "TaoBRGNSetRegularizerHessianRoutine_C", (Tao, Mat, PetscErrorCode (*)(Tao, Vec, Mat, void *), void *), (tao, Hreg, func, ctx));
705 static PetscErrorCode TaoBRGNSetRegularizerHessianRoutine_BRGN(Tao tao, Mat Hreg, PetscErrorCode (*func)(Tao tao, Vec u, Mat Hreg, PetscCtx ctx), PetscCtx ctx)
742 .seealso: `Tao`, `TaoBRGNGetSubsolver()`, `TaoBRGNSetRegularizerWeight()`, `TaoBRGNSetL1SmoothEpsilon()`, `TaoBRGNSetDictionaryMatrix()`,
745 PETSC_EXTERN PetscErrorCode TaoCreate_BRGN(Tao tao)