Home > manopt > core > canGetPrecon.m

canGetPrecon

PURPOSE ^

Checks whether a preconditioner was specified in the problem description.

SYNOPSIS ^

function candoit = canGetPrecon(problem)

DESCRIPTION ^

 Checks whether a preconditioner was specified in the problem description.

 function candoit = canGetPrecon(problem)

 Returns true if a preconditioner was specified, false otherwise. Notice
 that even if this function returns false, it is still possible to call
 getPrecon, as the default preconditioner is simply the identity operator.
 This check function is mostly useful to tell whether that default
 preconditioner will be in use or not.

 See also: getPrecon getSqrtPrecon canGetSqrtPrecon getHessian

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function candoit = canGetPrecon(problem)
0002 % Checks whether a preconditioner was specified in the problem description.
0003 %
0004 % function candoit = canGetPrecon(problem)
0005 %
0006 % Returns true if a preconditioner was specified, false otherwise. Notice
0007 % that even if this function returns false, it is still possible to call
0008 % getPrecon, as the default preconditioner is simply the identity operator.
0009 % This check function is mostly useful to tell whether that default
0010 % preconditioner will be in use or not.
0011 %
0012 % See also: getPrecon getSqrtPrecon canGetSqrtPrecon getHessian
0013 
0014 % This file is part of Manopt: www.manopt.org.
0015 % Original author: Nicolas Boumal, July 3, 2013.
0016 % Contributors:
0017 % Change log:
0018 
0019     candoit = isfield(problem, 'precon') || canGetSqrtPrecon(problem);
0020     
0021 end

Generated on Sat 12-Nov-2016 14:11:22 by m2html © 2005