Home > manopt > core > canGetDirectionalDerivative.m

canGetDirectionalDerivative

PURPOSE ^

Checks whether dir. derivatives can be computed for a problem structure.

SYNOPSIS ^

function candoit = canGetDirectionalDerivative(problem)

DESCRIPTION ^

 Checks whether dir. derivatives can be computed for a problem structure.
 
 function candoit = canGetDirectionalDerivative(problem)

 Returns true if the directional derivatives of the cost function can be
 computed given the problem description, false otherwise.

 See also: canGetCost canGetGradient canGetHessian

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function candoit = canGetDirectionalDerivative(problem)
0002 % Checks whether dir. derivatives can be computed for a problem structure.
0003 %
0004 % function candoit = canGetDirectionalDerivative(problem)
0005 %
0006 % Returns true if the directional derivatives of the cost function can be
0007 % computed given the problem description, false otherwise.
0008 %
0009 % See also: canGetCost canGetGradient canGetHessian
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     candoit = isfield(problem, 'diff') || canGetGradient(problem);
0017     
0018 end

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