Skip to content

Commit 72dc169

Browse files
dmdunladmdunla
committed
Adding v1.1 with documentation refactoring
0 parents  commit 72dc169

File tree

109 files changed

+6208
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+6208
-0
lines changed

‎COPYRIGHT.txt

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Poblano Toolbox for MATLAB
2+
3+
Copyright
4+
5+
Copyright 2009 National Technology & Engineering Solutions of Sandia,
6+
LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the
7+
U.S. Government retains certain rights in this software.
8+
9+
NOTICE:
10+
11+
For five (5) years from 06/20/2018 the United States Government is
12+
granted for itself and others acting on its behalf a paid-up,
13+
nonexclusive, irrevocable worldwide license in this data to reproduce,
14+
prepare derivative works, and perform publicly and display publicly,
15+
by or on behalf of the Government. There is provision for the possible
16+
extension of the term of this license. Subsequent to that period or
17+
any extension granted, the United States Government is granted for
18+
itself and others acting on its behalf a paid-up, nonexclusive,
19+
irrevocable worldwide license in this data to reproduce, prepare
20+
derivative works, distribute copies to the public, perform publicly
21+
and display publicly, and to permit others to do so. The specific term
22+
of the license can be identified by inquiry made to National
23+
Technology and Engineering Solutions of Sandia, LLC or DOE.
24+
25+
NEITHER THE UNITED STATES GOVERNMENT, NOR THE UNITED STATES DEPARTMENT
26+
OF ENERGY, NOR NATIONAL TECHNOLOGY AND ENGINEERING SOLUTIONS OF
27+
SANDIA, LLC, NOR ANY OF THEIR EMPLOYEES, MAKES ANY WARRANTY, EXPRESS
28+
OR IMPLIED, OR ASSUMES ANY LEGAL RESPONSIBILITY FOR THE ACCURACY,
29+
COMPLETENESS, OR USEFULNESS OF ANY INFORMATION, APPARATUS, PRODUCT, OR
30+
PROCESS DISCLOSED, OR REPRESENTS THAT ITS USE WOULD NOT INFRINGE
31+
PRIVATELY OWNED RIGHTS.
32+
33+
Any licensee of this software has the obligation and responsibility to
34+
abide by the applicable export control laws, regulations, and general
35+
prohibitions relating to the export of technical data. Failure to
36+
obtain an export control license or other authority from the
37+
Government may result in criminal liability under U.S. laws.
38+
39+

‎Contents.m

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
% Poblano Toolbox (Sandia National Labs)
2+
% Version 1.1 30-JAN-2012
3+
%
4+
% Poblano Toolbox for large-scale nonlinear optimization.
5+
%
6+
% cstep - More-Thuente line search step from MINPACK.
7+
% cvsrch - More-Thuente line search from MINPACK.
8+
% example1 - Example function for Poblano Toolbox routines.
9+
% example2 - Matrix factorization.
10+
% example2_extract - Matrix factorization example: extraction.
11+
% example2_init - Matrix factorization example: initialization.
12+
% gradientcheck - Finite difference verification of analytic gradients.
13+
% hessvec_fd - Hessian vector product finite difference approximation.
14+
% install_poblano - Script to install Poblano path.
15+
% lbfgs - Limited-memory BFGS minimization (vector-based).
16+
% ncg - Nonlinear conjugate gradient minimization.
17+
% poblano_linesearch - Line search methods in the Poblano Toolbox.
18+
% poblano_out - Standard output parameters for the Poblano Toolbox.
19+
% poblano_params - Standard input parameters for the Poblano Toolbox.
20+
% tn - Truncated Newton minimization.
21+
%
22+
%Poblano Toolbox for MATLAB
23+
%
24+
%Copyright 2009 National Technology & Engineering Solutions of Sandia,
25+
%LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the
26+
%U.S. Government retains certain rights in this software.

‎INSTALL.txt

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
To install the Poblano Toolbox for MATLAB:
2+
3+
1. Unpack the compressed file. In a linux environment, for example, this can
4+
be done from the command line via:
5+
6+
unzip poblano_toolbox_1.1.zip
7+
8+
*or*
9+
10+
gunzip -c poblano_toolbox_1.1.tgz | tar xvf -
11+
12+
This should create a directory named *poblano_toolbox_1.1*.
13+
14+
2. Rename the root directory from *poblano_toolbox_1.1* to *poblano_toolbox*.
15+
16+
3. Start MATLAB.
17+
18+
4. Within MATLAB, cd to the *poblano_toolbox* directory and execute the
19+
following commands:
20+
21+
addpath(pwd) %<-- Add the Poblano toolbox to the MATLAB path
22+
savepath %<-- Save for future MATLAB sessions
23+
24+
OR enter the following command:
25+
26+
install_poblano

‎LICENSE.txt

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Copyright 2009 National Technology & Engineering Solutions of Sandia,
2+
LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the
3+
U.S. Government retains certain rights in this software.
4+
5+
Redistribution and use in source and binary forms, with or without
6+
modification, are permitted provided that the following conditions are
7+
met:
8+
9+
1. Redistributions of source code must retain the above copyright
10+
notice, this list of conditions and the following disclaimer.
11+
12+
2. Redistributions in binary form must reproduce the above copyright
13+
notice, this list of conditions and the following disclaimer in the
14+
documentation and/or other materials provided with the distribution.
15+
16+
3. Neither the name of the copyright holder nor the names of its
17+
contributors may be used to endorse or promote products derived from
18+
this software without specific prior written permission.
19+
20+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24+
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Poblano Toolbox for MATLAB
2+
3+
```
4+
Copyright 2009 National Technology & Engineering Solutions of Sandia,
5+
LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the
6+
U.S. Government retains certain rights in this software.
7+
```
8+
9+
Poblano is a Matlab toolbox of large-scale algorithms for
10+
unconstrained nonlinear optimization problems. The algorithms in
11+
Poblano require only first-order derivative information (e.g.,
12+
gradients for scalar-valued objective functions), and therefore can
13+
scale to very large problems. The driving application for Poblano
14+
development has been tensor decompositions in data analysis
15+
applications (bibliometric analysis, social network analysis,
16+
chemometrics, etc.).
17+
18+
Poblano optimizers find local minimizers of scalar-valued objective
19+
functions taking vector inputs. The gradient (i.e., first derivative)
20+
of the objective function is required for all Poblano optimizers. The
21+
optimizers converge to a stationary point where the gradient is
22+
approximately zero. A line search satisfying the strong Wolfe
23+
conditions is used to guarantee global convergence of the Poblano
24+
optimizers. The optimization methods in Poblano include several
25+
nonlinear conjugate gradient methods (Fletcher-Reeves, Polak-Ribiere,
26+
Hestenes-Stiefel), a limited-memory quasi-Newton method using BFGS
27+
updates to approximate second-order derivative information, and a
28+
truncated Newton method using finite differences to approximate
29+
second-order derivative information.

‎RELEASE_NOTES.txt

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Poblano Toolbox version 1.1
2+
by Daniel M. Dunlavy, Tamara G. Kolda, and Evrim Acar.
3+
Copyright 2009-2012, Sandia Corporation.
4+
Released January 30, 2012.
5+
6+
============================================
7+
Changes from Version 1.0 (March 17, 2010.)
8+
============================================
9+
New features:
10+
- ExitDescription output parameter: contains text description of
11+
ExitFlag output parameter.
12+
- DisplayIters input parameter: determines how many iterations are
13+
performed before printing output when Display input parameter is
14+
set to 'iter'. Iteration 0 and final iteration are also printed.
15+
New default parameters:
16+
- MaxIters = 1000 (was 100)
17+
- MaxFuncEvals = 10000 (was 100)
18+
Bug fixes:
19+
- Fixed two-loop recursion bug in lbfgs.m (#19).
20+
- Documented initial step for linsearch in poblano_linesearch.m
21+
(#2, #18).
22+
Other changes:
23+
- Updated documentation for input and output parameters.
24+
- Updated URL for Poblano Toolbox.

0 commit comments

Comments
 (0)