Skip to content

Commit

Permalink
Updating documentation
Browse files Browse the repository at this point in the history 
Adding links in documentation for MATLAB and Statistics and Machine
Learning Toolbox.
  • Loading branch information
@mathinking
mathinking committed Feb 21, 2016
1 parent 8dcaebd commit 328506c
Show file tree
Hide file tree
Showing 13 changed files with 18 additions and 11 deletions.
5 changes: 3 additions & 2 deletions Hopfield Network Toolbox.prj
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<deployment-project plugin="plugin.toolbox" plugin-version="1.0">
<configuration build-checksum="3872350337" file="E:\Users\Lucas\Documents\GitHub\HopfieldNetworkToolbox\Hopfield Network Toolbox.prj" location="E:\Users\Lucas\Documents\GitHub\HopfieldNetworkToolbox" name="Hopfield Network Toolbox" target="target.toolbox" target-name="Package Toolbox">
<configuration build-checksum="2809269297" file="E:\Users\Lucas\Documents\GitHub\HopfieldNetworkToolbox\Hopfield Network Toolbox.prj" location="E:\Users\Lucas\Documents\GitHub\HopfieldNetworkToolbox" name="Hopfield Network Toolbox" target="target.toolbox" target-name="Package Toolbox">
<param.appname>Hopfield Network Toolbox</param.appname>
<param.authnamewatermark>Lucas García Rodríguez</param.authnamewatermark>
<param.email>[email protected]</param.email>
Expand Down Expand Up @@ -47,7 +47,8 @@
help_source/
Hopfield Net TSP solver_resources/
README.md
setup_hopfieldNetwork.m</param.exclude.filters>
setup_hopfieldNetwork.m
BuildInstructions.m</param.exclude.filters>
<param.examples>&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;examples&gt;
&lt;exampleCategory name="Solving the Traveling Salesman Problem using Hopfield Networks"&gt;
Expand Down
6 changes: 4 additions & 2 deletions help/html/chn_release_notes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,15 @@



</style></head><body><div class="content"><h1>Hopfield Network Toolbox Release Notes</h1><!--introduction--><p>This toolbox is solves combinatorial optimization problems by using Continuous Hopfield Networks (CHN).</p><p>The Hopfield Network Toolbox requires the following products: HERE</p><!--/introduction--><h2>Contents</h2><div><ul><li><a href="#1">Version 1.1.1, 21-Feb-2015</a></li><li><a href="#2">Version 1.1, 21-Feb-2015</a></li><li><a href="#4">Version 1.0, 02-Nov-2015</a></li><li><a href="#5">References</a></li></ul></div><h2>Version 1.1.1, 21-Feb-2015<a name="1"></a></h2><p>Bug fixing for Unix platforms</p><p>List of <a href="https://github.com/mathinking/HopfieldNetworkToolbox/issues?q=milestone%3Av1.1.1+is%3Aclosed+label%3Abug">Bugs</a> fixed in this release.</p><p><a href="https://github.com/mathinking/HopfieldNetworkToolbox/releases/tag/v1.1.1">Version 1.1.1 on GitHub</a></p><h2>Version 1.1, 21-Feb-2015<a name="2"></a></h2><p>New App, Toolbox Documentation and Examples.</p><p><a href="https://github.com/mathinking/HopfieldNetworkToolbox/issues?q=milestone%3Av1.1+is%3Aclosed+label%3Aenhancement">New Features</a>:</p><div><ul><li>Hopfield Net TSP solver App</li><li>Toolbox documentation</li><li>Step-by-step examples</li><li>TSPLIB automatic download</li></ul></div><p>List of <a href="https://github.com/mathinking/HopfieldNetworkToolbox/issues?q=milestone%3Av1.1+is%3Aclosed+label%3Abug">Bugs</a> fixed in this release.</p><p><a href="https://github.com/mathinking/HopfieldNetworkToolbox/releases/tag/v1.1">Version 1.1 on GitHub</a></p><h2>Version 1.0, 02-Nov-2015<a name="4"></a></h2><p>Initial release of Hopfield Network Toolbox.</p><p>This release is mainly focused in solving the Traveling Salesman Problem using the Continuous Hopfield Network (<i>CHN</i>). However, the release also provides a class structure to solve generic combinatorial optimization problems. Development in this area is undergoing.</p><p>The class to solve the TSP problems using <i>CHNs</i> is <tt>tsphopfieldnet</tt>. This network can solve any TSP problem, provided its coordinates or distance matrix. The Toolbox also includes the library TSPLIB, a de facto library for TSP benchmarks. Instances with up to 13509 cities have been tested using the <tt>tsphopfieldnet</tt> network. Note that solving such instances might require a large amount of memory.</p><p>Two main algorithms can be tested in this release:</p><div><ul><li><tt>talavan-yanez</tt>: based on the paper <a href="http://www.sciencedirect.com/science/article/pii/S0893608002000217">Parameter setting of the Hopfield network</a> applied to TSP by <i>Pedro M. Talav&aacute;n and Javier Y&aacute;&ntilde;ez</i>.</li><li><tt>divide-conquer</tt>: based on the paper (pending publishing at the time of this release) Improving the Hopfield model performance when applied to the traveling salesman problem: A divide-and-conquer scheme by <i>Lucas Garc&iacute;a, Pedro M. Talav&aacute;n and Javier Y&aacute;&ntilde;ez</i>.</li></ul></div><p><a href="https://github.com/mathinking/HopfieldNetworkToolbox/releases/tag/v1.0">Version 1.0 on GitHub</a></p><h2>References<a name="5"></a></h2><div><ul><li>Garc&iacute;a, L., Talav&aacute;n, P. M., &amp; Y&aacute;&ntilde;ez, J. (2016). <a href="http://link.springer.com/article/10.1007/s00500-016-2039-8">Improving the Hopfield model performance when applied to the traveling salesman problem</a>. Soft Computing, 1-15.</li><li>Talav&aacute;n, P. M., &amp; Y&aacute;&ntilde;ez, J. (2002). <a href="http://www.sciencedirect.com/science/article/pii/S0893608002000217">Parameter setting of the Hopfield network applied to TSP</a>. Neural Networks, 15(3), 363-373.</li><li>Talav&aacute;n, P. M., &amp; Y&aacute;&ntilde;ez, J. (2005). <a href="http://www.sciencedirect.com/science/article/pii/S0305054804000243">A continuous Hopfield network equilibrium points algorithm</a>. Computers &amp; operations research, 32(8), 2179-2196.</li></ul></div><p>The latest version of this toolbox is available on <a href="https://github.com/mathinking/HopfieldNetworkToolbox/releases/latest">GitHub</a>.</p><p class="footer"><br><a href="http://www.mathworks.com/products/matlab/">Published with MATLAB&reg; R2015b</a><br></p></div><!--
</style></head><body><div class="content"><h1>Hopfield Network Toolbox Release Notes</h1><!--introduction--><p>This toolbox is solves combinatorial optimization problems by using Continuous Hopfield Networks (CHN).</p><p>The Hopfield Network Toolbox requires the following products: <a href="mathworks.com/products/matlab">MATLAB&reg;</a> and <a href="http://www.mathworks.com/products/statistics/">Statistics and Machine Learning Toolbox&#8482;</a></p><!--/introduction--><h2>Contents</h2><div><ul><li><a href="#1">Version 1.1.1, 21-Feb-2015</a></li><li><a href="#2">Version 1.1, 21-Feb-2015</a></li><li><a href="#4">Version 1.0, 02-Nov-2015</a></li><li><a href="#5">References</a></li></ul></div><h2>Version 1.1.1, 21-Feb-2015<a name="1"></a></h2><p>Bug fixing for Unix platforms</p><p>List of <a href="https://github.com/mathinking/HopfieldNetworkToolbox/issues?q=milestone%3Av1.1.1+is%3Aclosed+label%3Abug">Bugs</a> fixed in this release.</p><p><a href="https://github.com/mathinking/HopfieldNetworkToolbox/releases/tag/v1.1.1">Version 1.1.1 on GitHub</a></p><h2>Version 1.1, 21-Feb-2015<a name="2"></a></h2><p>New App, Toolbox Documentation and Examples.</p><p><a href="https://github.com/mathinking/HopfieldNetworkToolbox/issues?q=milestone%3Av1.1+is%3Aclosed+label%3Aenhancement">New Features</a>:</p><div><ul><li>Hopfield Net TSP solver App</li><li>Toolbox documentation</li><li>Step-by-step examples</li><li>TSPLIB automatic download</li></ul></div><p>List of <a href="https://github.com/mathinking/HopfieldNetworkToolbox/issues?q=milestone%3Av1.1+is%3Aclosed+label%3Abug">Bugs</a> fixed in this release.</p><p><a href="https://github.com/mathinking/HopfieldNetworkToolbox/releases/tag/v1.1">Version 1.1 on GitHub</a></p><h2>Version 1.0, 02-Nov-2015<a name="4"></a></h2><p>Initial release of Hopfield Network Toolbox.</p><p>This release is mainly focused in solving the Traveling Salesman Problem using the Continuous Hopfield Network (<i>CHN</i>). However, the release also provides a class structure to solve generic combinatorial optimization problems. Development in this area is undergoing.</p><p>The class to solve the TSP problems using <i>CHNs</i> is <tt>tsphopfieldnet</tt>. This network can solve any TSP problem, provided its coordinates or distance matrix. The Toolbox also includes the library TSPLIB, a de facto library for TSP benchmarks. Instances with up to 13509 cities have been tested using the <tt>tsphopfieldnet</tt> network. Note that solving such instances might require a large amount of memory.</p><p>Two main algorithms can be tested in this release:</p><div><ul><li><tt>talavan-yanez</tt>: based on the paper <a href="http://www.sciencedirect.com/science/article/pii/S0893608002000217">Parameter setting of the Hopfield network</a> applied to TSP by <i>Pedro M. Talav&aacute;n and Javier Y&aacute;&ntilde;ez</i>.</li><li><tt>divide-conquer</tt>: based on the paper (pending publishing at the time of this release) Improving the Hopfield model performance when applied to the traveling salesman problem: A divide-and-conquer scheme by <i>Lucas Garc&iacute;a, Pedro M. Talav&aacute;n and Javier Y&aacute;&ntilde;ez</i>.</li></ul></div><p><a href="https://github.com/mathinking/HopfieldNetworkToolbox/releases/tag/v1.0">Version 1.0 on GitHub</a></p><h2>References<a name="5"></a></h2><div><ul><li>Garc&iacute;a, L., Talav&aacute;n, P. M., &amp; Y&aacute;&ntilde;ez, J. (2016). <a href="http://link.springer.com/article/10.1007/s00500-016-2039-8">Improving the Hopfield model performance when applied to the traveling salesman problem</a>. Soft Computing, 1-15.</li><li>Talav&aacute;n, P. M., &amp; Y&aacute;&ntilde;ez, J. (2002). <a href="http://www.sciencedirect.com/science/article/pii/S0893608002000217">Parameter setting of the Hopfield network applied to TSP</a>. Neural Networks, 15(3), 363-373.</li><li>Talav&aacute;n, P. M., &amp; Y&aacute;&ntilde;ez, J. (2005). <a href="http://www.sciencedirect.com/science/article/pii/S0305054804000243">A continuous Hopfield network equilibrium points algorithm</a>. Computers &amp; operations research, 32(8), 2179-2196.</li></ul></div><p>The latest version of this toolbox is available on <a href="https://github.com/mathinking/HopfieldNetworkToolbox/releases/latest">GitHub</a>.</p><p class="footer"><br><a href="http://www.mathworks.com/products/matlab/">Published with MATLAB&reg; R2015b</a><br></p></div><!--
##### SOURCE BEGIN #####
%% Hopfield Network Toolbox Release Notes
% This toolbox is solves combinatorial optimization problems by using
% Continuous Hopfield Networks (CHN).
%
% The Hopfield Network Toolbox requires the following products: HERE
% The Hopfield Network Toolbox requires the following products:
% <mathworks.com/products/matlab MATLAB®> and <http://www.mathworks.com/products/statistics/
% Statistics and Machine Learning Toolbox™>
%
%% Version 1.1.1, 21-Feb-2015
% Bug fixing for Unix platforms
Expand Down
9 changes: 5 additions & 4 deletions help/html/chn_system_requirements.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script><!--
This HTML was auto-generated from MATLAB code.
To make changes, update the MATLAB code and republish this document.
--><title>Hopfield Network Toolbox System Requirements</title><meta name="generator" content="MATLAB 8.6"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2016-02-20"><meta name="DC.source" content="chn_system_requirements.m"><style type="text/css">
--><title>Hopfield Network Toolbox System Requirements</title><meta name="generator" content="MATLAB 8.6"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2016-02-21"><meta name="DC.source" content="chn_system_requirements.m"><style type="text/css">
html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,acronym,address,big,cite,code,del,dfn,em,font,img,ins,kbd,q,s,samp,small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td{margin:0;padding:0;border:0;outline:0;font-size:100%;vertical-align:baseline;background:transparent}body{line-height:1}ol,ul{list-style:none}blockquote,q{quotes:none}blockquote:before,blockquote:after,q:before,q:after{content:'';content:none}:focus{outine:0}ins{text-decoration:none}del{text-decoration:line-through}table{border-collapse:collapse;border-spacing:0}

html { min-height:100%; margin-bottom:1px; }
Expand Down Expand Up @@ -66,11 +66,12 @@



</style></head><body><div class="content"><h1>Hopfield Network Toolbox System Requirements</h1><p>Hopfield Network Toolbox requires MATLAB&reg; and Statistics and Machine Learning Toolbox&#8482;</p><p class="footer"><br><a href="http://www.mathworks.com/products/matlab/">Published with MATLAB&reg; R2015b</a><br></p></div><!--
</style></head><body><div class="content"><h1>Hopfield Network Toolbox System Requirements</h1><p>Hopfield Network Toolbox requires <a href="mathworks.com/products/matlab">MATLAB&reg;</a> and <a href="http://www.mathworks.com/products/statistics/">Statistics and Machine Learning Toolbox&#8482;</a></p><p class="footer"><br><a href="http://www.mathworks.com/products/matlab/">Published with MATLAB&reg; R2015b</a><br></p></div><!--
##### SOURCE BEGIN #####
%% Hopfield Network Toolbox System Requirements
% Hopfield Network Toolbox requires MATLAB(R) and Statistics and Machine
% Learning Toolbox(TM)
% Hopfield Network Toolbox requires <mathworks.com/products/matlab MATLAB®>
% and <http://www.mathworks.com/products/statistics/ Statistics and Machine
% Learning Toolbox™>
%
##### SOURCE END #####
Expand Down
Binary file removed help/html/helpsearch-v3/_q.cfe
View file
Binary file not shown.
Binary file removed help/html/helpsearch-v3/_q.cfs
View file
Binary file not shown.
Binary file added help/html/helpsearch-v3/_s.cfe
View file
Binary file not shown.
Binary file added help/html/helpsearch-v3/_s.cfs
View file
Binary file not shown.
Binary file renamed help/html/helpsearch-v3/_q.si → help/html/helpsearch-v3/_s.si
View file
Binary file not shown.
Binary file modified help/html/helpsearch-v3/segments.gen
View file
Binary file not shown.
Binary file removed help/html/helpsearch-v3/segments_r
View file
Binary file not shown.
Binary file added help/html/helpsearch-v3/segments_t
View file
Binary file not shown.
4 changes: 3 additions & 1 deletion help_source/chn_release_notes.m
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
% This toolbox is solves combinatorial optimization problems by using
% Continuous Hopfield Networks (CHN).
%
% The Hopfield Network Toolbox requires the following products: HERE
% The Hopfield Network Toolbox requires the following products:
% <mathworks.com/products/matlab MATLAB®> and <http://www.mathworks.com/products/statistics/
% Statistics and Machine Learning Toolbox™>
%
%% Version 1.1.1, 21-Feb-2015
% Bug fixing for Unix platforms
Expand Down
5 changes: 3 additions & 2 deletions help_source/chn_system_requirements.m
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
%% Hopfield Network Toolbox System Requirements
% Hopfield Network Toolbox requires MATLAB(R) and Statistics and Machine
% Learning Toolbox(TM)
% Hopfield Network Toolbox requires <mathworks.com/products/matlab MATLAB®>
% and <http://www.mathworks.com/products/statistics/ Statistics and Machine
% Learning Toolbox™>
%

0 comments on commit 328506c

Please sign in to comment.