Home > manopt > autodiff > functions_AD > cindex.m

cindex

PURPOSE ^

Array Indexing

SYNOPSIS ^

function Xindex = cindex(X)

DESCRIPTION ^

 Array Indexing

 function Xindex = cindex(X)

 Indexing X according to the user's need. Fill the ... in the bracket.
 The input should accept either a numeric array or a struct with fields
 real and imag.

 See also: manoptADhelp

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function Xindex = cindex(X)
0002 % Array Indexing
0003 %
0004 % function Xindex = cindex(X)
0005 %
0006 % Indexing X according to the user's need. Fill the ... in the bracket.
0007 % The input should accept either a numeric array or a struct with fields
0008 % real and imag.
0009 %
0010 % See also: manoptADhelp
0011 
0012 % This file is part of Manopt: www.manopt.org.
0013 % Original author: Xiaowen Jiang, July 31, 2021.
0014 % Contributors:
0015 % Change log:
0016 
0017     fprintf(['cindex: This is a template. Please create your own ' ...
0018              'function following the instructions in the comments.'])
0019 
0020     % if iscstruct(X)
0021     %    Xindex.real = X(...);
0022     %    Xindex.imag = X(...);
0023     % elseif isnumeric(X)
0024     %    Xindex = X(...);
0025     % else
0026     %    ME = MException('cindex:inputError', ...
0027     %    'Input does not have the expected format.');
0028     %    throw(ME);
0029     % end
0030 
0031 end

Generated on Fri 30-Sep-2022 13:18:25 by m2html © 2005