Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Adding v1.1 with documentation refactoring
  • Loading branch information
dmdunla committed Apr 25, 2019
0 parents commit 72dc169
Show file tree
Hide file tree
Showing 109 changed files with 6,208 additions and 0 deletions.
39 changes: 39 additions & 0 deletions COPYRIGHT.txt
@@ -0,0 +1,39 @@
Poblano Toolbox for MATLAB

Copyright

Copyright 2009 National Technology & Engineering Solutions of Sandia,
LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the
U.S. Government retains certain rights in this software.

NOTICE:

For five (5) years from 06/20/2018 the United States Government is
granted for itself and others acting on its behalf a paid-up,
nonexclusive, irrevocable worldwide license in this data to reproduce,
prepare derivative works, and perform publicly and display publicly,
by or on behalf of the Government. There is provision for the possible
extension of the term of this license. Subsequent to that period or
any extension granted, the United States Government is granted for
itself and others acting on its behalf a paid-up, nonexclusive,
irrevocable worldwide license in this data to reproduce, prepare
derivative works, distribute copies to the public, perform publicly
and display publicly, and to permit others to do so. The specific term
of the license can be identified by inquiry made to National
Technology and Engineering Solutions of Sandia, LLC or DOE.

NEITHER THE UNITED STATES GOVERNMENT, NOR THE UNITED STATES DEPARTMENT
OF ENERGY, NOR NATIONAL TECHNOLOGY AND ENGINEERING SOLUTIONS OF
SANDIA, LLC, NOR ANY OF THEIR EMPLOYEES, MAKES ANY WARRANTY, EXPRESS
OR IMPLIED, OR ASSUMES ANY LEGAL RESPONSIBILITY FOR THE ACCURACY,
COMPLETENESS, OR USEFULNESS OF ANY INFORMATION, APPARATUS, PRODUCT, OR
PROCESS DISCLOSED, OR REPRESENTS THAT ITS USE WOULD NOT INFRINGE
PRIVATELY OWNED RIGHTS.

Any licensee of this software has the obligation and responsibility to
abide by the applicable export control laws, regulations, and general
prohibitions relating to the export of technical data. Failure to
obtain an export control license or other authority from the
Government may result in criminal liability under U.S. laws.


26 changes: 26 additions & 0 deletions Contents.m
@@ -0,0 +1,26 @@
% Poblano Toolbox (Sandia National Labs)
% Version 1.1 30-JAN-2012
%
% Poblano Toolbox for large-scale nonlinear optimization.
%
% cstep - More-Thuente line search step from MINPACK.
% cvsrch - More-Thuente line search from MINPACK.
% example1 - Example function for Poblano Toolbox routines.
% example2 - Matrix factorization.
% example2_extract - Matrix factorization example: extraction.
% example2_init - Matrix factorization example: initialization.
% gradientcheck - Finite difference verification of analytic gradients.
% hessvec_fd - Hessian vector product finite difference approximation.
% install_poblano - Script to install Poblano path.
% lbfgs - Limited-memory BFGS minimization (vector-based).
% ncg - Nonlinear conjugate gradient minimization.
% poblano_linesearch - Line search methods in the Poblano Toolbox.
% poblano_out - Standard output parameters for the Poblano Toolbox.
% poblano_params - Standard input parameters for the Poblano Toolbox.
% tn - Truncated Newton minimization.
%
%Poblano Toolbox for MATLAB
%
%Copyright 2009 National Technology & Engineering Solutions of Sandia,
%LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the
%U.S. Government retains certain rights in this software.
26 changes: 26 additions & 0 deletions INSTALL.txt
@@ -0,0 +1,26 @@
To install the Poblano Toolbox for MATLAB:

1. Unpack the compressed file. In a linux environment, for example, this can
be done from the command line via:

unzip poblano_toolbox_1.1.zip

*or*

gunzip -c poblano_toolbox_1.1.tgz | tar xvf -

This should create a directory named *poblano_toolbox_1.1*.

2. Rename the root directory from *poblano_toolbox_1.1* to *poblano_toolbox*.

3. Start MATLAB.

4. Within MATLAB, cd to the *poblano_toolbox* directory and execute the
following commands:

addpath(pwd) %<-- Add the Poblano toolbox to the MATLAB path
savepath %<-- Save for future MATLAB sessions

OR enter the following command:

install_poblano
30 changes: 30 additions & 0 deletions LICENSE.txt
@@ -0,0 +1,30 @@
Copyright 2009 National Technology & Engineering Solutions of Sandia,
LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the
U.S. Government retains certain rights in this software.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 changes: 29 additions & 0 deletions README.md
@@ -0,0 +1,29 @@
# Poblano Toolbox for MATLAB

```
Copyright 2009 National Technology & Engineering Solutions of Sandia,
LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the
U.S. Government retains certain rights in this software.
```

Poblano is a Matlab toolbox of large-scale algorithms for
unconstrained nonlinear optimization problems. The algorithms in
Poblano require only first-order derivative information (e.g.,
gradients for scalar-valued objective functions), and therefore can
scale to very large problems. The driving application for Poblano
development has been tensor decompositions in data analysis
applications (bibliometric analysis, social network analysis,
chemometrics, etc.).

Poblano optimizers find local minimizers of scalar-valued objective
functions taking vector inputs. The gradient (i.e., first derivative)
of the objective function is required for all Poblano optimizers. The
optimizers converge to a stationary point where the gradient is
approximately zero. A line search satisfying the strong Wolfe
conditions is used to guarantee global convergence of the Poblano
optimizers. The optimization methods in Poblano include several
nonlinear conjugate gradient methods (Fletcher-Reeves, Polak-Ribiere,
Hestenes-Stiefel), a limited-memory quasi-Newton method using BFGS
updates to approximate second-order derivative information, and a
truncated Newton method using finite differences to approximate
second-order derivative information.
24 changes: 24 additions & 0 deletions RELEASE_NOTES.txt
@@ -0,0 +1,24 @@
Poblano Toolbox version 1.1
by Daniel M. Dunlavy, Tamara G. Kolda, and Evrim Acar.
Copyright 2009-2012, Sandia Corporation.
Released January 30, 2012.

============================================
Changes from Version 1.0 (March 17, 2010.)
============================================
New features:
- ExitDescription output parameter: contains text description of
ExitFlag output parameter.
- DisplayIters input parameter: determines how many iterations are
performed before printing output when Display input parameter is
set to 'iter'. Iteration 0 and final iteration are also printed.
New default parameters:
- MaxIters = 1000 (was 100)
- MaxFuncEvals = 10000 (was 100)
Bug fixes:
- Fixed two-loop recursion bug in lbfgs.m (#19).
- Documented initial step for linsearch in poblano_linesearch.m
(#2, #18).
Other changes:
- Updated documentation for input and output parameters.
- Updated URL for Poblano Toolbox.

0 comments on commit 72dc169

Please sign in to comment.