forked from etheriau/OpenForecast
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathoverview-summary.html
212 lines (181 loc) · 10.1 KB
/
overview-summary.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_20) on Sun May 29 20:35:02 CDT 2011 -->
<TITLE>
Overview (OpenForecast API)
</TITLE>
<META NAME="date" CONTENT="2011-05-29">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Overview (OpenForecast API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Overview</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="index.html?overview-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="overview-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<CENTER>
<H1>
OpenForecast
</H1>
</CENTER>
OpenForecast is a package of general purpose, forecasting models
written in Java that can be applied to any data series.
<P>
<B>See:</B>
<BR>
<A HREF="#overview_description"><B>Description</B></A>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Packages</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><B><A HREF="net/sourceforge/openforecast/package-summary.html">net.sourceforge.openforecast</A></B></TD>
<TD>This is the main package for OpenForecast.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><B><A HREF="net/sourceforge/openforecast/input/package-summary.html">net.sourceforge.openforecast.input</A></B></TD>
<TD>Defines a variety of helper classes used for creating DataSet and
DataPoint objects from a variety of different input sources.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><B><A HREF="net/sourceforge/openforecast/models/package-summary.html">net.sourceforge.openforecast.models</A></B></TD>
<TD>Defines the different ForecastingModels implemented in OpenForecast.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><B><A HREF="net/sourceforge/openforecast/output/package-summary.html">net.sourceforge.openforecast.output</A></B></TD>
<TD>Defines a variety of helper classes used for outputting DataSet and
DataPoint objects to a variety of different output sources.</TD>
</TR>
</TABLE>
<P>
<A NAME="overview_description"><!-- --></A>
<P>
<p>OpenForecast is a package of general purpose, forecasting models
written in Java that can be applied to any data series. One of the design
goals is to make it easy for a developer to use in an application even if
they do not understand, or care to understand, the differences between the
different forecasting models available.</p>
<p>The general steps involved in using OpenForecast are as follows:</p>
<ul>
<li>Create a <A HREF="net/sourceforge/openforecast/DataSet.html" title="class in net.sourceforge.openforecast"><CODE>DataSet</CODE></A> object.</li>
<li>Add to the data set object a series of <A HREF="net/sourceforge/openforecast/DataPoint.html" title="interface in net.sourceforge.openforecast"><CODE>DataPoint</CODE></A> objects that define a series of observations.</li>
<li>Using the static <A HREF="net/sourceforge/openforecast/Forecaster.html#getBestForecast(net.sourceforge.openforecast.DataSet)"><CODE>getBestForecast</CODE></A> method of <A HREF="net/sourceforge/openforecast/Forecaster.html" title="class in net.sourceforge.openforecast"><CODE>Forecaster</CODE></A>, obtain a reference to the most appropriate forecast model for your data set.</li>
<li>Use the <A HREF="net/sourceforge/openforecast/ForecastingModel.html#forecast(net.sourceforge.openforecast.DataPoint)"><CODE>forecast</CODE></A> method of this <A HREF="net/sourceforge/openforecast/ForecastingModel.html" title="interface in net.sourceforge.openforecast"><CODE>ForecastingModel</CODE></A> to forecast additional values.</li>
</ul>
<p>That's all there is to it.</p>
<p>Alternatively, if you want to force the application of a specific forecasting model, then refer to the class implementing that model in the <A HREF="net/sourceforge/openforecast/models/package-summary.html"><CODE>net.sourceforge.openforecast.models</CODE></A> package.</p>
<h2>Packaging of OpenForecast</h2>
<p>OpenForecast is primarily a Java library - a JAR file named, <code>OpenForecast-</code><em>{version}</em><code>.jar</code> - intended for use in other Java applications, including web applications.</p>
<p>A simple GUI is also being implemented for OpenForecast. Since the main focus of the OpenForecast project is to develop a powerful forecasting library, the UI code is not bundled with the main JAR file. [Since it's open source you can change this packaging if you want.] As a result, the OpenForecast UI is packaged in the JAR file, <code>OpenForecastUI-</code><em>{version}</em><code>.jar</code>.</p>
<p>Additionally, OpenForecast also comes with a test suite and some examples showing how to use it to generate forecasts. Neither of these are packaged separately, since it is not expected that you'll ever need to include these directly in your application(s).</p>
<p>Although OpenForecast is distributed primarily as two JAR files - one for the core library and another for the OpenForecast UI - the API documentation here includes all classes in both of these JARs. Everything in the <CODE>net.sourceforge.openforecast.ui</CODE> package (and subpackages) forms part of the OpenForecast UI, and is <em>not</em> included in the core library. All other packages comprise the main OpenForecast library. [Note that the OpenForecast UI package is still in the early phases of development and has not yet been released.]</p>
<h2>Updates</h2>
<p>You can always download the latest version of OpenForecast from the <a href="http://openforecast.sf.net/" target="_blank">OpenForecast web site</a> on <a href="http://www.sourceforge.net/" target="_blank">SourceForge.net</a>.</p>
<P>
<P>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Overview</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="index.html?overview-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="overview-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<a href='http://openforecast.sf.net/' target='_blank'>OpenForecast</a>, Copyright (c) <a href='http://www.stevengould.org/' target='_blank'>Steven Gould</a>, 2002-2011
</BODY>
</HTML>