Fix typos

QMCSoftware · Jul 4, 2020 · 0362970 · 0362970
1 parent e5ad204
commit 0362970
Show file tree

Hide file tree

Showing 6 changed files with 116 additions and 138 deletions.
diff --git a/qmcpy/README.md b/qmcpy/README.md
@@ -72,5 +72,5 @@ Has class method `integrate` which preforms numerical integration.
 **MC Algorithms**
 
   - Multilevel MC Cubature
-  - Garunteed MC Cubature
+  - Guaranteed MC Cubature
   - CLT MC Cubature 
diff --git a/qmcpy/stopping_criterion/cub_mc_g.py b/qmcpy/stopping_criterion/cub_mc_g.py
@@ -14,15 +14,15 @@
 
 class CubMCG(StoppingCriterion):
     """
-    Stopping Criterion with garunteed accuracy
+    Stopping criterion with guaranteed accuracy
 
     >>> k = Keister(Gaussian(IIDStdUniform(2,seed=7),covariance=1./2))
     >>> sc = CubMCG(k,abs_tol=.05)
     >>> solution,data = sc.integrate()
     >>> solution
     1.803926962264685
     >>> data
-    Solution: 1.8039         
+    Solution: 1.8039
     Keister (Integrand Object)
     IIDStdUniform (DiscreteDistribution Object)
         dimension       2^(1)
@@ -50,10 +50,10 @@ class CubMCG(StoppingCriterion):
         https://github.com/GailGithub/GAIL_Dev/blob/master/Algorithms/IntegrationExpectation/meanMC_g.m
 
     Reference:
-        
+
         [1] Sou-Cheng T. Choi, Yuhan Ding, Fred J. Hickernell, Lan Jiang, Lluis Antoni Jimenez Rugama,
-        Da Li, Jagadeeswaran Rathinavel, Xin Tong, Kan Zhang, Yizhi Zhang, and Xuan Zhou, 
-        GAIL: Guaranteed Automatic Integration Library (Version 2.3) [MATLAB Software], 2019. 
+        Da Li, Jagadeeswaran Rathinavel, Xin Tong, Kan Zhang, Yizhi Zhang, and Xuan Zhou,
+        GAIL: Guaranteed Automatic Integration Library (Version 2.3) [MATLAB Software], 2019.
         Available from http://gailgithub.github.io/GAIL_Dev/
 
     Guarantee
@@ -125,7 +125,7 @@ def integrate(self):
             alphai = (self.alpha-self.alpha_sigma)/(2*(1-self.alpha_sigma)) # uncertainty to do iteration
             eps1 = self._ncbinv(1e4,alphai,self.kurtmax)
             self.err_bar = self.sigma_up*eps1
-            tau = 1. # step of the iteration 
+            tau = 1. # step of the iteration
             self.data.n[:] = 1e4 # default initial sample size
             while True:
                 if self.data.n_total + self.data.n > self.n_max:
@@ -158,7 +158,7 @@ def integrate(self):
                 toloversig = self.err_bar / self.sigma_up
                 alphai = 2**tau * (self.alpha - self.alpha_sigma) / (1 - self.alpha_sigma)
                 n,_ = self._nchebe(toloversig, alphai, self.kurtmax, self.n_max, self.sigma_up)
-                self.data.n[:] = n            
+                self.data.n[:] = n
         # set confidence interval
         self.data.confid_int = self.data.solution + self.err_bar * array([-1, 1])
         self.data.time_integrate = time() - t_start

diff --git a/sphinx/algorithms.rst b/sphinx/algorithms.rst
@@ -36,7 +36,7 @@ Asian Call Option
 .. automodule:: qmcpy.integrand.asian_call
     :members:
 
-Multilevel Call Options with Milstein Discretization 
+Multilevel Call Options with Milstein Discretization
 ...............................................
 
 .. automodule:: qmcpy.integrand.ml_call_options
@@ -121,13 +121,13 @@ Sobol'
 Halton
 ......
 
-.. automodule:: qmcpy.discrete_distribution.halton 
+.. automodule:: qmcpy.discrete_distribution.halton
     :members:
 
 Korobov
 .......
 
-.. automodule:: qmcpy.discrete_distribution.korobov  
+.. automodule:: qmcpy.discrete_distribution.korobov
     :members:
 
 IID Standard Uniform
@@ -171,13 +171,13 @@ Abstract Stopping Criterion Class
 .. automodule:: qmcpy.stopping_criterion._stopping_criterion
     :members:
 
-Garunteed Lattice Cubature (qMC)
+Guaranteed Lattice Cubature (qMC)
 ................................
 
 .. automodule:: qmcpy.stopping_criterion.cub_qmc_lattice_g
     :members:
 
-Garunteed Sobol Cubature (qMC)
+Guaranteed Sobol Cubature (qMC)
 ..............................
 
 .. automodule:: qmcpy.stopping_criterion.cub_qmc_sobol_g
@@ -201,7 +201,7 @@ Multilevel MC Cubature
 .. automodule:: qmcpy.stopping_criterion.cub_mc_ml
     :members:
 
-Garunteed MC Cubature
+Guaranteed MC Cubature
 ...............................
 
 .. automodule:: qmcpy.stopping_criterion.cub_mc_g
@@ -247,7 +247,7 @@ Multilevel MC Data
 
 .. automodule:: qmcpy.accumulate_data.mlmc_data
     :members:
-    
+
 Mean Variance MC Data
 .......................
 

diff --git a/sphinx/conf.py b/sphinx/conf.py
@@ -26,11 +26,11 @@
 # -- Project information -----------------------------------------------------
 project = u"QMCPy"
 copyright = u"2019, Illinois Institute of Technology"
-author = u"Fred J. Hickernell, Aleksei Sorokin, Sou-Cheng T. Choi"
-version = u"0.1"
+author = u"Sou-Cheng T. Choi, Fred J. Hickernell, Michael McCourt, Jagadeeswaran Rathinavel, and Aleksei Sorokin"
+version = u"0.3"
 
 # The full version, including alpha/beta/rc tags
-release = u"0.1"
+release = version
 master_doc = 'index'