Home > manopt > core > canGetEuclideanGradient.m

canGetEuclideanGradient

PURPOSE ^

Checks whether the Euclidean gradient can be computed for a problem.

SYNOPSIS ^

function candoit = canGetEuclideanGradient(problem)

DESCRIPTION ^

 Checks whether the Euclidean gradient can be computed for a problem.

 function candoit = canGetEuclideanGradient(problem)

 Returns true if the Euclidean gradient can be computed given the problem
 description, false otherwise.

 See also: canGetGradient getEuclideanGradient

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function candoit = canGetEuclideanGradient(problem)
0002 % Checks whether the Euclidean gradient can be computed for a problem.
0003 %
0004 % function candoit = canGetEuclideanGradient(problem)
0005 %
0006 % Returns true if the Euclidean gradient can be computed given the problem
0007 % description, false otherwise.
0008 %
0009 % See also: canGetGradient getEuclideanGradient
0010 
0011 % This file is part of Manopt: www.manopt.org.
0012 % Original author: Nicolas Boumal, Dec. 30, 2012.
0013 % Contributors:
0014 % Change log:
0015 %
0016 %   June 28, 2016 (NB):
0017 %       Added support for getPartialEuclideanGradient
0018 
0019 
0020     candoit = isfield(problem, 'egrad') || canGetPartialEuclideanGradient(problem);
0021     
0022 end

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