+{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeFamilies #-}
-- | Classical iterative methods to solve the system Ax = b.
-module Linear.Iteration
+module Linear.Iteration (
+ gauss_seidel_iteration,
+ gauss_seidel_iterations,
+ gauss_seidel_method,
+ jacobi_iteration,
+ jacobi_iterations,
+ jacobi_method,
+ rayleigh_quotient,
+ sor_iteration,
+ sor_iterations,
+ sor_method )
where
-import Data.List (find)
-import Data.Maybe (fromJust)
-import Data.Vector.Fixed (Arity, N1, S)
-import NumericPrelude hiding ((*))
-import qualified Algebra.Algebraic as Algebraic
-import qualified Algebra.Field as Field
-import qualified Algebra.RealField as RealField
-import qualified Algebra.ToRational as ToRational
-import qualified Prelude as P
+import Data.List ( find )
+import Data.Maybe ( fromJust )
+import Data.Vector.Fixed ( Arity, N1, S )
+import NumericPrelude hiding ( (*) )
+import qualified Algebra.Algebraic as Algebraic ( C )
+import qualified Algebra.Field as Field ( C )
+import qualified Algebra.RealField as RealField ( C )
+import qualified Algebra.ToRational as ToRational ( C )
+
+import Linear.Matrix (
+ Mat(..),
+ (!!!),
+ (*),
+ diagonal_part,
+ dot,
+ lt_part_strict,
+ transpose )
+import Linear.System ( forward_substitute )
+import Normed ( Normed(..) )
-import Linear.Matrix
-import Linear.System
-import Normed
-- | A generalized implementation for Jacobi, Gauss-Seidel, etc. All
-- that we really need to know is how to construct the matrix M, so we
--
-- Examples:
--
+-- >>> import Linear.Matrix ( Mat2, fromList, vec2d )
+--
-- >>> let m = fromList [[4,2],[2,2]] :: Mat2 Double
-- >>> let x0 = vec2d (0, 0::Double)
-- >>> let b = vec2d (1, 1::Double)
--
-- Examples:
--
+-- >>> import Linear.Matrix ( Mat2, fromList, vec2d )
+--
-- >>> let m = fromList [[4,2],[2,2]] :: Mat2 Double
-- >>> let x0 = vec2d (0, 0::Double)
-- >>> let b = vec2d (1, 1::Double)
--
-- Examples:
--
+-- >>> import Linear.Matrix ( Mat2, fromList, vec2d )
+--
-- >>> let m = fromList [[4,2],[2,2]] :: Mat2 Double
-- >>> let x0 = vec2d (0, 0::Double)
-- >>> let b = vec2d (1, 1::Double)
--
-- Examples:
--
+-- >>> import Linear.Matrix ( Mat2, fromList, vec2d )
+--
-- >>> let m = fromList [[4,2],[2,2]] :: Mat2 Double
-- >>> let x0 = vec2d (0, 0::Double)
-- >>> let b = vec2d (1, 1::Double)
--
-- Examples:
--
+-- >>> import Linear.Matrix ( Mat2, fromList, vec2d )
+--
-- >>> let m = fromList [[3,1],[1,2]] :: Mat2 Rational
-- >>> let v = vec2d (1, 1::Rational)
-- >>> rayleigh_quotient m v