Commit b9621488 authored by Tim Mitchell's avatar Tim Mitchell
Browse files

updated all caps for MATLAB in help doc and strings

parent 8f2bbb8d
......@@ -5,7 +5,7 @@ function cleanEigsPlus(varargin)
%
% USAGE:
% % Removes all versions of the files created by each call to
% % makeEigsPlus(), called on whichver versions of Matlab.
% % makeEigsPlus(), called on whichver versions of MATLAB.
% > cleanEigsPlus()
%
% % Remove a specific version of the files created by makeEigsPlus()
......@@ -17,8 +17,8 @@ function cleanEigsPlus(varargin)
% > cleanEigsPlus('2015a')
%
% NOTE:
% This command is only applicable on Matlab, not Octave, as the
% eigs patching features are Matlab-only features.
% This command is only applicable on MATLAB, not Octave, as the
% eigs patching features are MATLAB-only features.
%
% See also eigsPlus, makeEigsPlus.
%
......@@ -54,7 +54,7 @@ function cleanEigsPlus(varargin)
error( 'cleanEigsPlus:octave', ...
[ 'Nothing to clean.\n' ...
'eigsPlus patching features are only supported on ' ...
'Matlab, not Octave. eigsPlus may still be used ' ...
'MATLAB, not Octave. eigsPlus may still be used ' ...
'on Octave, but not all features will be enabled.' ]);
end
......@@ -70,7 +70,7 @@ function cleanEigsPlus(varargin)
% supported by eigsPlus
if strCompareTo('2012b',version_str) > 0
error( 'cleanEigsPlus:unsupportedMatlab', ...
'eigsPlus requires Matlab R2012b or newer.' );
'eigsPlus requires MATLAB R2012b or newer.' );
end
cleanEigsPlusVersion(version_str);
......
function varargout = eigsPlus(varargin)
% eigsPlus:
% eigsPlus is an enhanced version of Matlab's eigs command that
% eigsPlus is an enhanced version of MATLAB's eigs command that
% provides the following modifications:
%
% 1) Only the converged eigenvalues and eigenvalue eigenvector pairs
......@@ -10,7 +10,7 @@ function varargout = eigsPlus(varargin)
% computation. If none converge, empty arrays are returned.
%
% 2) The eigenvalues are always returned in a column vector, and
% never a diagonal matrix, unlike Matlab's eigs routine which
% never a diagonal matrix, unlike MATLAB's eigs routine which
% will return the eigenvalues as a diagonal matrix when
% eigenvectors are always requested.
%
......@@ -39,7 +39,7 @@ function varargout = eigsPlus(varargin)
% 5) R2017a and earlier only: the user may set opts.isreal to false
% to force the complex ARPACK routines to be used even if matrix
% A is real and opts.v0 is either real or complex (whereas
% Matlabs's eigs would throw an error in these cases). eigsPlus
% MATLABs's eigs would throw an error in these cases). eigsPlus
% will throw an error in either of these cases if opts.isreal is
% either not provided or if it is set to true.
%
......@@ -51,7 +51,7 @@ function varargout = eigsPlus(varargin)
% evaluations.
%
% eigsPlus was first created to handle a problem that can arise with eigs
% on Matlab (R2013a and earlier) and on current versions of Octave (4.0).
% on MATLAB (R2013a and earlier) and on current versions of Octave (4.0).
% If a user requests k eigenvalues but ARPACK then fails to resolve k
% eigenvalues, then, on the affected platforms, eigs will return the
% converged eigenvalues along with zeros as placeholders for the
......
function makeEigsPlus()
% makeEigsPlus:
% Installs the eigsPlus function for the currenly running release of
% Matlab. Each install is version specific so this command will need
% to be rerun for each version of Matlab used. eigsPlus can also be
% MATLAB. Each install is version specific so this command will need
% to be rerun for each version of MATLAB used. eigsPlus can also be
% used on Octave, though not all of its features will be enabled.
% Running this routine will create up to two .m files in the
% 'private' subfolder of the eigsPlus installation location.
%
% Matlab releases prior to R2012b are NOT supported.
% MATLAB releases prior to R2012b are NOT supported.
%
% NOTE:
% To run makeEigsPlus, both the patch and md5 commands must be
......@@ -48,7 +48,7 @@ function makeEigsPlus()
if isOctave()
error( 'makeEigsPlus:octave', ...
[ 'eigsPlus patching features are only supported on ' ...
'Matlab, not Octave. eigsPlus may still be used ' ...
'MATLAB, not Octave. eigsPlus may still be used ' ...
'on Octave, but not all features will be enabled.' ]);
end
......@@ -62,19 +62,19 @@ function makeEigsPlus()
sparfun_path = [mr fs 'toolbox' fs 'matlab' fs 'sparfun'];
eigs_name = [sparfun_path fs 'eigs.m'];
% get details for this version of Matlab (and ensures that it is at
% get details for this version of MATLAB (and ensures that it is at
% least R2012b)
[suffix,rel_name,newer_matlab] = getEigsPlusSuffix();
% load the saved check_sum variable for the specific version of eigs.m
load([diff_path fs 'eigs_md5_' suffix '.mat']);
% get the md5 check sum of eigs, from the running version of Matlab,
% get the md5 check sum of eigs, from the running version of MATLAB,
% and compare to the stored md5 check sum for eigs - they should match!
[err_status,eigs_cs] = system(['md5 -q ' eigs_name]);
if err_status
error( 'makeEigsPlus:checkSumError', ...
[ 'Failed to produce a md5 check sum of Matlab''s ' ...
[ 'Failed to produce a md5 check sum of MATLAB''s ' ...
'eigs.m. Please see the eigsPlus webpage for ' ...
'support options.' ] );
end
......@@ -82,14 +82,14 @@ function makeEigsPlus()
if newer_matlab
writeConfigurationFile(rel_name,true);
error('makeEigsPlus:unsupportedMatlab', ...
[ 'Newer unsupported Matlab version detected. ' ...
[ 'Newer unsupported MATLAB version detected. ' ...
'eigsPlus may still be used, but not all ' ...
'features will be enabled. Please check the ' ...
'eigsPlus website if a newer version of ' ...
'eigsPlus is available.' ] );
end
error( 'makeEigsPlus:checkSumMismatch', ...
[ 'The md5 check sum of Matlab''s eigs.m does not ' ...
[ 'The md5 check sum of MATLAB''s eigs.m does not ' ...
'match the known version. Please see the eigsPlus '...
'webpage for support options.' ] );
end
......@@ -115,5 +115,5 @@ function makeEigsPlus()
writeConfigurationFile(rel_name);
fprintf('eigsPlus successfully installed for Matlab R%s.\n',rel_name);
fprintf('eigsPlus successfully installed for MATLAB R%s.\n',rel_name);
end
\ No newline at end of file
......@@ -2,7 +2,7 @@ function fn = getEigsPlusFunction()
% getEigsPlusFunction:
% Returns a function handle to the version-specific patched eigsPlus
% routine. This will throw an error if eigsPlus is not installed for
% the currently running version of Matlab or if eigsPlus is
% the currently running version of MATLAB or if eigsPlus is
% improperly configured (the latter which only applies to 2013a or
% earlier releases).
%
......@@ -47,10 +47,10 @@ function fn = getEigsPlusFunction()
config_name = [base_path fs config_fn];
eigsPlus_name = [base_path fs eigsPlus_fn];
% make sure eigsPlus is installed for this version of Matlab
% make sure eigsPlus is installed for this version of MATLAB
if ~exist(config_name,'file') || ~exist(eigsPlus_name,'file')
error( 'eigsPlus:notInstalled', ...
[ 'New version of Matlab detected, run ' ...
[ 'New version of MATLAB detected, run ' ...
'makeEigsPlus() to install/update eigsPlus.'] );
end
......@@ -60,7 +60,7 @@ function fn = getEigsPlusFunction()
if use_eigs_fn()
if ~atLeastVersion('2013b')
error( 'eigsPlus:invalidConfiguration', ...
[ 'eigsPlus can only be downgraded to Matlab''s ' ...
[ 'eigsPlus can only be downgraded to MATLAB''s ' ...
'default version of eigs on R2013b and later.' ]);
end
eigs_fn = @eigs;
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment