sglib_version.m

function [version, msgs]=sglib_version(varargin)
% SGLIB_VERSION Returns version information for sglib.
%   VERSION=SGLIB_VERSION Returns version information for sglib either as
%   array or in string format (if the option 'as_string' is specified). 
%
%   VERSION=SGLIB_VERSION('as_string', true) Returns version information
%   for sglib  in string format. 
%
%   [VERSION, MSGS]=SGLIB_VERSION Returns an addtional cell array
%   containing string messages with important information about possibly
%   incompatible changes. 
%
% Note:
%   The code of SGLIB_VERSION will also contain a log of the major
%   improvements of sglib (some kind of 'whats_new' file.
%
% Example (<a href="matlab:run_example sglib_version">run</a>)
%   fprintf('Version as array:  ');
%   disp(sglib_version())
%   fprintf('Version as string: ');
%   disp(sglib_version('as_string', true))
%
% See also VERSION, SGLIB_STARTUP

%   Elmar Zander
%   Copyright 2013, Inst. of Scientific Computing, TU Braunschweig
%
%   This program is free software: you can redistribute it and/or modify it
%   under the terms of the GNU General Public License as published by the
%   Free Software Foundation, either version 3 of the License, or (at your
%   option) any later version. 
%   See the GNU General Public License for more details. You should have
%   received a copy of the GNU General Public License along with this
%   program.  If not, see <http://www.gnu.org/licenses/>.

options = varargin2options(varargin);
[as_string, options] = get_option(options, 'as_string', false);
check_unsupported_options(options, mfilename);

msgs = {};

% Version information follows:
% If the change is minor add to the last digit, large changes the middle
% digit, and if the change is large and may be incompatible to previous
% versions increase the first digit.

% Version 0.9.1
% Up to here no version information existed

% Version 0.9.2
% * Added version information

% Version 0.9.3
% * Added option for computing squared gpc norm
% * Added option to make ordering of multiindices compatible with UQToolkit
% * Incompatible change to 'multiindex' interface when used with more than
%   two arguments (removed optional 'combine' parameter)
msgs{end+1} = 'Attention (0.9.3): incompatible change in ''multiindex'' when called with more than two parameters (see help).';

% Version 0.9.4
% * Extended SQRSPACE to cope with negative values and different exponents.
% * Added Matern and rational quadratic covariance function models

% Version 0.9.5
% * Added gpc_partial_eval for partial evaluation of GPCs
% * Added gpc_integrate for integration over GPC spaces
% * Added gpc_basis_eval for quick evaluation of the GPC basis functions
% * Added monomial evaluation to gpc_evaluate

% Version 0.9.6
% * Cleanup of linalg (esp. subspace_distance and subspace_angles)
% * Added composite and nested trapezoidal rule.
% * Improved Clenshaw-Curtis rule 
msgs{end+1} = 'Attention (0.9.6): clenshaw_curtis_legendre_rule removed. Use clenshaw_curtis_nested instead.';

% Version 0.9.7
% * Added gpc_moments function
% * gpc_integrate can report nodes and weight and also transform the nodes
% * Added Latin hypercube sampling for uniform random vars
% * Lots of cleanup (directories, compatibility, comments, ...)
% * New demonstrations (for the UQ lecture, and D. Xiu's book)
% * Added inverse CDF's for various distributions
% * Various small performance and interface improvements
msgs{end+1} = 'Attention (0.9.7): large restructuring of sglib directories!';

% Version 0.9.8
% * Added Latin hypercube sampling and QMC for GPC
% * Added computation of GPC covariance matrices
% * Improved gpcbasis_create and _size functions
% * Added functions for plotting of response surfaces
% * Added functions for approximating maps between rv's 

% Version 0.9.9
% * Some of the demos were moved to sglib-testing
% * Lots of bug-fixes and cleanup
% * New quadrature rules like nested CC, Fejer 1&2, and Newton-Cotes
% * Renaming of GPC functions for consistency (gpcgerm_xyz, gpcbasis_xzy)
% * New system for specifying general distributions (gendist_...)
% * Added chi-squared distributions, several new stats functions
% * Cleanup of munit and linalg
msgs(1:end) = [];
msgs{end+1} = 'Attention (0.9.9): Again large restructuring of sglib directories!';
msgs{end+1} = '                   Some functions have been moved to the repo sglib-testing, until they are completed.';
version = [0, 9, 9];

% Version 0.9.10

% If Version information is requested as string, convert the arrary
% to string inserting some dots between the numbers.
if as_string
    version = sprintf('%d.', version);
    version = version(1:end-1);
end