Commit 1c098db0 authored by Tammy Kolda's avatar Tammy Kolda
Browse files

Merge branch 'Release-3.2-Prep' into 'master'

Release 3.2 prep

Closes #49

See merge request !58
parents df9ebad9 9fd39eac
Pipeline #254580098 passed with stage
in 42 seconds
......@@ -46,7 +46,7 @@
%
% See also TENSOR_TOOLBOX
%
%MATLAB Tensor Toolbox. Copyright 2017, Sandia Corporation.
%Tensor Toolbox for MATLAB: <a href="https://www.tensortoolbox.org">www.tensortoolbox.org</a>
function t = ktensor(varargin)
%KTENSOR Tensor stored as a Kruskal operator (decomposed).
......
......@@ -21,7 +21,7 @@
%
% See also TENSOR_TOOLBOX
%
%MATLAB Tensor Toolbox. Copyright 2017, Sandia Corporation.
%Tensor Toolbox for MATLAB: <a href="https://www.tensortoolbox.org">www.tensortoolbox.org</a>
function a = sptenmat(varargin)
%SPTENMAT Matricized sparse tensor stored as a sparse 2D array.
......
......@@ -62,9 +62,9 @@
% How to cite the sptensor class:
% * B.W. Bader and T.G. Kolda. Efficient MATLAB Computations with Sparse
% and Factored Tensors, SIAM J. Scientific Computing, 30:205-231, 2007,
% http:dx.doi.org/10.1137/060676489.
% http://dx.doi.org/10.1137/060676489.
%
%MATLAB Tensor Toolbox. Copyright 2017, Sandia Corporation.
%Tensor Toolbox for MATLAB: <a href="https://www.tensortoolbox.org">www.tensortoolbox.org</a>
function t = sptensor(varargin)
%SPTENSOR Create a sparse tensor.
......
......@@ -22,7 +22,7 @@
%
% See also TENSOR_TOOLBOX
%
%MATLAB Tensor Toolbox. Copyright 2017, Sandia Corporation.
%Tensor Toolbox for MATLAB: <a href="https://www.tensortoolbox.org">www.tensortoolbox.org</a>
function t = sumtensor(varargin)
%SUMTENSOR Tensor stored as sum of tensors.
......
......@@ -38,7 +38,7 @@
%
% See also TENSOR_TOOLBOX, SYMTENSOR
%
%MATLAB Tensor Toolbox. Copyright 2017, Sandia Corporation.
%Tensor Toolbox for MATLAB: <a href="https://www.tensortoolbox.org">www.tensortoolbox.org</a>
function t = symktensor(varargin)
%SYMKTENSOR Tensor stored as a symmetric Kruskal operator (decomposed).
......
......@@ -22,7 +22,7 @@
%
% See also TENSOR_TOOLBOX
%
%MATLAB Tensor Toolbox. Copyright 2017, Sandia Corporation.
%Tensor Toolbox for MATLAB: <a href="https://www.tensortoolbox.org">www.tensortoolbox.org</a>
function A = tenmat(varargin)
%TENMAT Create a matricized tensor.
......
......@@ -67,8 +67,7 @@
% Fast Algorithm Prototyping, ACM Trans. Mathematical Software,
% 32:635-653, 2006, http://dx.doi.org/10.1145/1186785.1186794.
%
%MATLAB Tensor Toolbox. Copyright 2017, Sandia Corporation.
%Tensor Toolbox for MATLAB: <a href="https://www.tensortoolbox.org">www.tensortoolbox.org</a>
function t = tensor(varargin)
%TENSOR Create tensor.
......
......@@ -28,7 +28,7 @@
%
% See also TENSOR_TOOLBOX
%
%MATLAB Tensor Toolbox. Copyright 2017, Sandia Corporation.
%Tensor Toolbox for MATLAB: <a href="https://www.tensortoolbox.org">www.tensortoolbox.org</a>
function t = ttensor(varargin)
%TTENSOR Tensor stored as a Tucker operator (decomposed).
......
% Tensor Toolbox (Sandia National Labs)
% Version 3.2-a (Development Version) 25-Jan-2021
% Version 3.2 (R2021a) 10-Feb-2021
% Tensor Toolbox for dense, sparse, and decomposed n-way arrays.
%
% Tensor Toolbox Classes:
......@@ -51,4 +51,4 @@
%
% <a href="matlab:web(strcat('file://',fullfile(getfield(what('tensor_toolbox'),'path'),'doc','html','index.html')))">Documentation page for Tensor Toolbox</a>
%
%Tensor Toolbox for MATLAB, https://www.tensortoolbox.org/
%Tensor Toolbox for MATLAB: <a href="https://www.tensortoolbox.org">www.tensortoolbox.org</a>
Please remember to cite the appropriate references when you have used
Tensor Toolbox in your work. See "How to Cite" under
http://www.sandia.gov/~tgkolda/TensorToolbox/ for more details.
To install the Tensor Toolbox for MATLAB:
1. Unpack the compressed file. In a linux environment, for example, this can
be done from the command line via:
unzip tensor_toolbox_2.6.zip
*or*
gunzip -c tensor_toolbox_2.6.tar.gz | tar xvf -
This should create a directory named *tensor_toolbox_2.6*.
2. Rename the root directory from *tensor_toolbox_2.6*
to *tensor_toolbox*.
3. Start MATLAB.
4. Within MATLAB, cd to the *tensor_toolbox* directory and execute the
following commands:
addpath(pwd) %<-- Add the tensor toolbox to the MATLAB path
cd met; addpath(pwd) %<-- [OPTIONAL] Also add the met directory
savepath %<-- Save for future MATLAB sessions
5. For help, type
help tensor_toolbox
To see the documentation, go to the help home screen.
Click "Supplemental Software" in the lower left.
Choose "Tensor Toolbox" and browse the pages.
For help on MET, be sure that the met directory is on your path and
then get a directory listing with explanation by typing
help met
\ No newline at end of file
# Tensor Toolbox for MATLAB, Version 3.2-a
Current development version
# Tensor Toolbox for MATLAB, Version 3.2
February 10, 2021
by Brett W. Bader, Tamara G. Kolda, Daniel M. Dunlavy, et al.
Sandia National Laboratories
......@@ -14,16 +14,36 @@ Release notes follow below.
## Changes from Version 3.1 (June 4, 2019)
- Overhaul of documentation (see !53), including new logo (see !55)
- Added [HTML documentation](doc/html/eig_geap_doc.html) for `eig_geap.m` (see !54)
- Added support to export a `ktensor` in [`export_data.m`](export_data.m).
- Fixing bug in [`@ktensor/score.m`](@ktensor/score.m) with zero lambdas in both inputs.
- Added [`sptenmat` constructor](@sptenmat/sptenmat.m) check on valid input.
- Added new functionality for implicit symmetric CP tensor
computation, including new top-level function [`cp_isym`](cp_isym.m).
- Added interfaces to various optimization methods, including
our own implementation of ADAM.
- Added new functionality for implicit symmetric CP tensor computation per the paper: S. Sherman, T. G. Kolda. Estimating Higher-Order Moments Using Symmetric Tensor Decomposition, SIMAX, 2020 (see !43)
* New top-level function [`cp_isym`](cp_isym.m)
* New functions within [`symktensor`](@symktensor/) class: [`f_implicit`](@symktensor/f_implicit.m), [`fg_explicit`](@symktensor/fg_explicit.m), [`fg_implicit`](@symktensor/fg_implicit.m), [`g_implicit`](@symktensor/g_implicit.m), [`randextract`](@symktensor/randextract.m), [`update`](@symkensor/update.m)
* New help page: [Implicit Symmetric CP Decomposition for Symmetric K-Tensors](https://www.tensortoolbox.org/cp_isym_doc.html)
- Added interfaces to various optimization methods, including our own implementation of ADAM (see also !43)
* New top-level *hidden* functions that serve as somewhat standardized wrappers to optimization methods: [`tt_opt_adam`](tt_opt_adam.m), [`tt_opt_fminunc`](tt_opt_fminunc.m), [`tt_opt_lbfgs`](tt_opt_lbfgs.m), [`tt_opt_lbfgsb.m`](tt_opt_lbfgsb.m)
* New help pages: [Optimization Methods for Tensor Toolbox](https://www.tensortoolbox.com/opt_options_doc.html) and [Developer Information for Optimization Methods in Tensor Toolbox](https://www.tensortoolbox.com/tt_opt_doc.html)
- Other new help pages:
* [Shifted Power Method for Generalized Tensor Eigenproblem](https://www.tensortoolbox.com/eig_geap_doc.html) documenting [`eig_geap`](eig_geap.m) (fixes #11, see !54)
* [Symmetric CP Decomposition for Symmetric Tensors](https://www.tensortoolbox.com/cp_sym_doc.html) documenting [`cp_sym`](cp_sym.m) (see !43)
- Overhaul of documentation (see !53), including [new logo](doc/html/Tensor-Toolbox-for-MATLAB-Banner.png) (see !55, fixes #18)
* Plus updated [Contribution Guide](CONTRIBUTION_GUIDE.md) with better instructions (see !44)
* Added funding and other acknowledgments to [`CONTRIBUTORS.md`](CONTRIBUTORS.md)
* Removed `RELEASE_NOTES.txt`, putting release notes into `README.md` (this file) in markdown format
* Removed `INSTALL.txt`, which was out of date
* Added [Release Instructions](maintenance/RELEASE_INSTRUCTIONS.md) and [Documentation Instructions](maintenance/DOCUMENTATION_INSTRUCTIONS.md)
* Added functions to update toolbox link in `maintenance`
* Removed `doc/html/bibtex.html`, `doc/html/getting_started.html`, `doc/html/helpscreen.PNG`
- Various bug fixes and minor enhancements
* Fixed bug in [`@ktensor/score.m`](@ktensor/score.m) to handle zero lambda-values in both inputs (fixes #37)
* Added [`sptenmat` constructor](@sptenmat/sptenmat.m) check on valid input (fixes #33)
* Fixed wrong default lower bound in [`gcp_opt`](gcp_opt.m)
* Specified in [`tucker_sym`](tucker_sym.m) that input must be a `tensor` rather than a `symtensor`, which is admittedly counterintuitive (fixes #44)
* Fix [`sparse/ttt`](@sptensor/ttt.m) and [`sparse/ttm`](@sptensor/ttm.m) for complex tensors (fixes #40)
* Fix [`ktensor/full`](@ktensor/full.m) for complex tensors
* Updated documentation links so that every file now links to www.tensortoolbox.org (fixes #14, see !57)
* Added support to export a `ktensor` in [`export_data.m`](export_data.m) plus relevant tests (fixes #23)
* Updated [`symktensor/normalize`](@symktensor/normalize.m) to be faster by using `bsxfun`
* Added/updated paper links: [`tensor`](@tensor/tensor.m), [`sptensor`](@sptensor/sptensor.m), [`cp_arls`](cp_arls.m), [`cp_sym`](cp_sym.m)
## Changes from Version 2.6 (February 6, 2015)
- Changed license conditions: now open source BSD license.
......
<?xml version='1.0' encoding='ISO-8859-1' ?>
<!-- $Revision: 1.1 $ $Date: 2006/08/30 23:22:37 $ -->
<toc version="3.2-a">
<toc version="3.2">
<tocitem target="index.html" >Tensor Toolbox
......
......@@ -11,7 +11,7 @@
<a href="index.html"><img src="Tensor-Toolbox-for-MATLAB-Banner.png"></img></a>
</div>
<div class="content">
<h1 id="home">Tensor Toolbox for MATLAB, Version 3.2-a</h1>
<h1 id="home">Tensor Toolbox for MATLAB, Version 3.2</h1>
<p>The Tensor Toolbox for MATLAB provides a suite of tools for
working with multidimensional or N-way arrays. Tensor
......@@ -30,8 +30,9 @@
for the terms of the license (2-clause BSD).
</p>
<ul>
<li><a href="https://gitlab.com/tensors/tensor_toolbox/-/releases">Current release of Tensor Toolbox for MATLAB (v3.1)</a></li>
<li><a href="http://gitlab.com/tensors/tensor_toolbox">Current development version from GITLAB repository (v3.2-a)</a></li>
<li><a href="https://gitlab.com/tensors/tensor_toolbox/-/releases/v3.2">Tensor Toolbox for MATLAB v3.2 (current release) </a></li>
<li><a href="https://gitlab.com/tensors/tensor_toolbox/-/releases/v3.1">Tensor Toolbox for MATLAB v3.1</a></li>
<li><a href="http://gitlab.com/tensors/tensor_toolbox">Current development version from GITLAB repository</a></li>
</ul>
<p>Be advised that a recent version of MATLAB is required.
......@@ -88,17 +89,17 @@
<ul class=citations>
<li><b>General software, latest release:</b>
Brett W. Bader, Tamara G. Kolda and others,
Tensor Toolbox for MATLAB, Version 3.1,
Tensor Toolbox for MATLAB, Version 3.2,
<a href="https://www.tensortoolbox.org">www.tensortoolbox.org</a>,
June 4, 2019.
February 10, 2021.
<li><b>General software, development version:</b>
Brett W. Bader, Tamara G. Kolda and others,
Tensor Toolbox for MATLAB, development version <span class="untermstring">(3.2-a.f339cea5)</span>,
Tensor Toolbox for MATLAB, development version <span class="untermstring">[hash]</span>,
available online at
<a href="https://www.tensortoolbox.org">https://www.tensortoolbox.org</a>,
<span class="untermstring">December 15, 2020</span>.
<span class="untermstring">date</span>.
<ul>
<li><em>Replace the version and date to match the current development version.
<li><em>Replace the hash and date to match the current development version.
Generate the appropriate hash via</em> <tt>git log --pretty=format:'%h' -n 1</tt>.</li>
</ul>
<li><b>Dense tensors:</b>
......
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