Permalink
Browse files

Cleaned descriptions. Haddock documentation builds now.

  • Loading branch information...
1 parent 5667173 commit 8973c8f26e2b0fbdfbe89615e44dfd9236068df0 @hijarian committed Jan 22, 2012
Showing with 27 additions and 23 deletions.
  1. +23 −19 Numeric/Functions/Theta.hs
  2. +4 −4 theta-functions.cabal
View
42 Numeric/Functions/Theta.hs
@@ -1,22 +1,25 @@
-{- |
- Theta-functions implemented on top of trigonometric series.
- Theta-functions are special functions of several complex variables
- Their importance is that we can construct an elliptic functions from
- combination of theta-functions
-
- http://en.wikipedia.org/wiki/Theta_function
-
- Depend on parameter <tau>, which should be positive
- Call every function as thetaN <n> (qpar <tau>) <u>
- where <n> is a number of addends in series representing the function
- <tau> is a tau parameter defining the theta-function
- <u> is an argument, which is a complex number
-
- WARNING: theta-functions are raising their values very quickly when arg is raising.
- This depends on behaviour of cos and sin of complex functions,
- which are very rapidly increasing their values.
- Call theta-functions with n < 20, q < 1, |u| < pi
--}
+-- |
+-- Theta-functions implemented on top of trigonometric series.
+--
+-- Theta-functions are special functions of several complex variables
+-- Their importance is that we can construct an elliptic functions from
+-- combination of theta-functions, see details at
+-- <http://en.wikipedia.org/wiki/Theta_function>.
+--
+-- Depend on parameter Tau, which should be positive.
+-- Call every function in the following form:
+--
+-- @theta1 N (qpar Tau) U@
+--
+-- where @N@ is a number of addends in series representing the function,
+-- @Tau@ is a tau parameter defining the theta-function and
+-- @U@ is an argument, which is a complex number.
+--
+-- WARNING: theta-functions are raising their values very quickly when arg is raising.
+-- This depends on behaviour of cos and sin of complex functions,
+-- which are very rapidly increasing their values.
+-- Call theta-functions with n < 20, q < 1, |u| < pi.
+
module Numeric.Functions.Theta (
qpar,
theta1,
@@ -67,6 +70,7 @@ qpar tau
| otherwise = throw $ ErrorCall "tau should be > 0 !"
-- | Complex signum function.
+-- Equivalent to raising (-1) to the power of n
signfun :: (RealFloat a) => Integer -> Complex a
signfun nn
| odd nn = ((-1) :+ 0)
View
8 theta-functions.cabal
@@ -5,7 +5,7 @@ Synopsis: Theta-functions implemented as trigonometric series
Description:
Small and simple library for computing values of Theta functions.
- They're the special functions of two variables. Described very well at "http://en.wikipedia.org/wiki/Theta_function".
+ They're the special functions of two variables. Described very well at Wikipedia article with corresponding name.
Library exports four theta-functions and a small helper to calculate their second parameter.
Theta functions are functions of Complex variables, FYI.
@@ -19,13 +19,13 @@ Category: Math
Build-type: Simple
-Extra-source-files: README.md
-
Homepage: https://github.com/hijarian/theta-functions
+Extra-source-files: README.md
+
Library
Exposed-modules: Numeric.Functions.Theta
- Build-Depends: base >= 4.3 && < 5
+ Build-Depends: base >= 4.3.1.0 && < 5
Source-repository head
type: git

0 comments on commit 8973c8f

Please sign in to comment.