<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>C++ API frePPLe: module_forecast::Forecast::ForecastMethod Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="../styles.css" rel="stylesheet" type="text/css">
</head>
<body>
<div id="container">
<div id="menubar">
<div id="logo" align="center">
<br/><img src='../frepple.bmp' alt="frepple" /><br/>
<a href='http://www.frepple.com/'>
<strong>a Free<br/>Production Planning<br/>Library</strong>
</a>
</div>
<div id="menu">
<br/>
<h3><a href='../Main/HomePage.html'>Main</a></h3>
<h3><a href='../UI/Main.html'>User Manual</a></h3>
<h3><a href='../Tutorial/Main.html'>Tutorial</a></h3>
<h3><a href='../Frepple/Main.html'>Reference Manual</a></h3>
<h3><a href='../Main/FAQ.html'>FAQ</a></h3>
<h3><a href='index.html'>C++ API</a></h3>
<br/>
</div>
</div>
<div id="content">
<br/>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00258.html">module_forecast</a>::<a class="el" href="a00072.html">Forecast</a>::<a class="el" href="a00074.html">ForecastMethod</a>
</div>
</div>
<div class="contents">
<h1>module_forecast::Forecast::ForecastMethod Class Reference</h1><!-- doxytag: class="module_forecast::Forecast::ForecastMethod" -->
<p>Abstract base class for all forecasting methods.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00204_source.html">forecast.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for module_forecast::Forecast::ForecastMethod:</div>
<div class="dynsection">
<div class="center"><img src="a00673.png" border="0" usemap="#module__forecast_1_1_forecast_1_1_forecast_method_inherit__map" alt="Inheritance graph"/></div>
<map name="module__forecast_1_1_forecast_1_1_forecast_method_inherit__map" id="module__forecast_1_1_forecast_1_1_forecast_method_inherit__map">
<area shape="rect" id="node3" href="a00043.html" title="A class to calculate a forecast with Croston's method." alt="" coords="364,5,591,33"/>
<area shape="rect" id="node5" href="a00055.html" title="A class to perform double exponential smoothing on a time series." alt="" coords="332,55,623,83"/>
<area shape="rect" id="node7" href="a00116.html" title="A class to calculate a forecast based on a moving average." alt="" coords="343,106,612,134"/>
<area shape="rect" id="node9" href="a00164.html" title="A class to perform seasonal forecasting on a time series." alt="" coords="359,157,596,185"/>
<area shape="rect" id="node11" href="a00169.html" title="A class to perform single exponential smoothing on a time series." alt="" coords="333,207,621,235"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00674.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#a5b6313466ac20ca0e9a74139e868f04a">applyForecast</a> (<a class="el" href="a00072.html">Forecast</a> *, const <a class="el" href="a00049.html">Date</a>[], unsigned int, bool)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#a72078544ba513ac4d9bae0ef64045480">generateForecast</a> (<a class="el" href="a00072.html">Forecast</a> *, const double[], unsigned int, const double[], bool)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#a5dff95401a41f796fbc243f4996afd27">getName</a> ()=0</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Abstract base class for all forecasting methods. </p>
<p>Definition at line <a class="el" href="a00204_source.html#l00302">302</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5b6313466ac20ca0e9a74139e868f04a"></a><!-- doxytag: member="module_forecast::Forecast::ForecastMethod::applyForecast" ref="a5b6313466ac20ca0e9a74139e868f04a" args="(Forecast *, const Date[], unsigned int, bool)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void module_forecast::Forecast::ForecastMethod::applyForecast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00072.html">Forecast</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const </td>
<td class="paramname"> <em>Date</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>int</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is called when this forecast method has generated the lowest forecast error and now needs to set the forecast values. </p>
<p>Implemented in <a class="el" href="a00116.html#ae131a917e8a5aec9d09c81dd7aa0e453">module_forecast::Forecast::MovingAverage</a>, <a class="el" href="a00169.html#a794f9e1de08be94cad1df91e5090853d">module_forecast::Forecast::SingleExponential</a>, <a class="el" href="a00055.html#a86cd527c2908e510cbe90882e1c91423">module_forecast::Forecast::DoubleExponential</a>, <a class="el" href="a00164.html#ab23016bb3cf139abe2905331679ea93e">module_forecast::Forecast::Seasonal</a>, and <a class="el" href="a00043.html#afe2fcb57e279d7b9a5dfcbbed45cabd8">module_forecast::Forecast::Croston</a>.</p>
</div>
</div>
<a class="anchor" id="a72078544ba513ac4d9bae0ef64045480"></a><!-- doxytag: member="module_forecast::Forecast::ForecastMethod::generateForecast" ref="a72078544ba513ac4d9bae0ef64045480" args="(Forecast *, const double[], unsigned int, const double[], bool)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual double module_forecast::Forecast::ForecastMethod::generateForecast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00072.html">Forecast</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const </td>
<td class="paramname"> <em>double</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>int</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const </td>
<td class="paramname"> <em>double</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="a00072.html" title="This class represents a bucketized demand signal.">Forecast</a> evaluation. </p>
<p>Implemented in <a class="el" href="a00116.html#ab58b0e26e945b213dff768d92470733b">module_forecast::Forecast::MovingAverage</a>, <a class="el" href="a00169.html#af3071583d861c5cb288b57076bbaac7e">module_forecast::Forecast::SingleExponential</a>, <a class="el" href="a00055.html#a2ab0d08f2c0b5e8c4a48396e4b26e93b">module_forecast::Forecast::DoubleExponential</a>, <a class="el" href="a00164.html#ac833784cd01b9729013fb75799a6368e">module_forecast::Forecast::Seasonal</a>, and <a class="el" href="a00043.html#a6d771f314418b878562305f4f24bbeae">module_forecast::Forecast::Croston</a>.</p>
</div>
</div>
<a class="anchor" id="a5dff95401a41f796fbc243f4996afd27"></a><!-- doxytag: member="module_forecast::Forecast::ForecastMethod::getName" ref="a5dff95401a41f796fbc243f4996afd27" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual string module_forecast::Forecast::ForecastMethod::getName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name of the method. </p>
<p>Implemented in <a class="el" href="a00116.html#a417566305e4377e105080c97569f9d5a">module_forecast::Forecast::MovingAverage</a>, <a class="el" href="a00169.html#affbb76afc2986d615477aab22f8e0c7e">module_forecast::Forecast::SingleExponential</a>, <a class="el" href="a00055.html#adc0a96c3fa752f116266db734103645d">module_forecast::Forecast::DoubleExponential</a>, <a class="el" href="a00164.html#af9eddeb354e34d191232ee0de1b4c40b">module_forecast::Forecast::Seasonal</a>, and <a class="el" href="a00043.html#a92db1a691233a916086d87c80d6f6965">module_forecast::Forecast::Croston</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00204_source.html">forecast.h</a></li>
</ul>
</div>
<hr size="1"/><address style="align: right;"><small>Documentation generated for frePPLe by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"/></a></small></address>
</div>
</div>
</body>
</html>
