Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / financial-0.4.0 / yahoo.m

diff --git a/octave_packages/financial-0.4.0/yahoo.m b/octave_packages/financial-0.4.0/yahoo.m
new file mode 100644 (file)
index 0000000..1088d5b
--- /dev/null
+++ b/octave_packages/financial-0.4.0/yahoo.m
@@ -0,0 +1,44 @@
+## Copyright (C) 2008 Bill Denney <bill@denney.ws>
+##
+## This program is free software; you can redistribute it and/or modify it 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.
+##
+## This program 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.
+##
+## You should have received a copy of the GNU General Public License along with
+## this program; if not, see <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn {Function File} {@var{conn} =} yahoo ()
+## @deftypefnx {Function File} {@var{conn} =} yahoo (@var{URL}, @var{ipaddress}, @var{port})
+##
+## Prepare a Yahoo connection for the fetch command to get Yahoo
+## historical quote data.
+##
+## If given, the @var{URL} must be "http://quote.yahoo.com".  The
+## @var{ipaddress} and @var{port} is the proxy ipaddress and port. These
+## parameters are currently ignored (with a warning if given).
+##
+## @seealso{fetch, google}
+## @end deftypefn
+
+## FIXME: Actually use the proxy info if given.
+
+function conn = yahoo (url="http://quote.yahoo.com", ipaddr="", port=[])
+
+  if ! strcmpi (url, "http://quote.yahoo.com")
+    error ("url must be 'http://quote.yahoo.com'")
+  elseif ! (isempty (ipaddr) && isempty (port))
+    warning ("Proxy information is currently ignored")
+  endif
+
+  conn.url  = url;
+  conn.ip   = ipaddr;
+  conn.port = port;
+
+endfunction