Home > src > genericAnneal.m

# genericAnneal

## PURPOSE

- abstract interface for annealing objects

## SYNOPSIS

This is a script file.

## DESCRIPTION

     - abstract interface for annealing objects

     copyright 2009-2012 Blair Armstrong, Christine Watson, David Plaut

        This file is part of SOS

        SOS is free software: you can redistribute it and/or modify
        it for academic and non-commercial purposes
        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.  For commercial or for-profit
        uses, please contact the authors (sos@cnbc.cmu.edu).

        SOS is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU General Public License for more details.

## CROSS-REFERENCE INFORMATION

This function calls:

- genericAnneal - abstract interface for annealing objects

This function is called by:

- expAnneal - exponentially-decaying temperature annealing object
- genericAnneal - abstract interface for annealing objects
- greedyAnneal - greedy annealing (i.e., T = 0) object

## SOURCE CODE

    0001 % - abstract interface for annealing objects
    0002 %
    0003 % copyright 2009-2012 Blair Armstrong, Christine Watson, David Plaut
    0004 %
    0005 %    This file is part of SOS
    0006 %
    0007 %    SOS is free software: you can redistribute it and/or modify
    0008 %    it for academic and non-commercial purposes
    0009 %    under the terms of the GNU General Public License as published by
    0010 %    the Free Software Foundation, either version 3 of the License, or
    0011 %    (at your option) any later version.  For commercial or for-profit
    0012 %    uses, please contact the authors (sos@cnbc.cmu.edu).
    0013 %
    0014 %    SOS is distributed in the hope that it will be useful,
    0015 %    but WITHOUT ANY WARRANTY; without even the implied warranty of
    0016 %    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    0017 %    GNU General Public License for more details.
    0018
    0019 %    You should have received a copy of the GNU General Public License
    0020 %    along with SOS (see COPYING.txt).
    0021 %    If not, see <http://www.gnu.org/licenses/>.
    0022
    0023
    0024 classdef genericAnneal < handle
    0025     %% Abstract interface for all annealing objects
    0026
    0027     properties
    0028         temp % stores the current temperature
    0029     end
    0030
    0031     % methods that must be included in all anneal objects
    0032     methods (Abstract)
    0033         getTemp(obj);
    0034         anneal(obj,curIt,costHistory);
    0035     end
    0036 end