Mercurial > octave-antonio

comparison scripts/specfun/primes.m @ 20162:2645f9ef8c88 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed specfun, special-matrix, testfun, and time script directories. * scripts/specfun/expint.m, scripts/specfun/isprime.m, scripts/specfun/legendre.m, scripts/specfun/primes.m, scripts/specfun/reallog.m, scripts/specfun/realsqrt.m, scripts/special-matrix/gallery.m, scripts/special-matrix/hadamard.m, scripts/special-matrix/hankel.m, scripts/special-matrix/hilb.m, scripts/special-matrix/invhilb.m, scripts/special-matrix/magic.m, scripts/special-matrix/pascal.m, scripts/special-matrix/rosser.m, scripts/special-matrix/toeplitz.m, scripts/special-matrix/vander.m, scripts/special-matrix/wilkinson.m, scripts/testfun/assert.m, scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/fail.m, scripts/testfun/rundemos.m, scripts/testfun/runtests.m, scripts/testfun/speed.m, scripts/time/asctime.m, scripts/time/calendar.m, scripts/time/clock.m, scripts/time/ctime.m, scripts/time/datenum.m, scripts/time/datestr.m, scripts/time/datevec.m, scripts/time/etime.m, scripts/time/is_leap_year.m, scripts/time/now.m, scripts/time/weekday.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 17:00:11 -0700
parents 4197fc428c7d
children
comparison
equal deleted inserted replaced
20160:03b9d17a2d95 20162:2645f9ef8c88
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} primes (@var{n}) 20 ## @deftypefn {Function File} {} primes (@var{n})
21 ## Return all primes up to @var{n}. 21 ## Return all primes up to @var{n}.
22 ## 22 ##
23 ## The output data class (double, single, uint32, etc.) is the same as 23 ## The output data class (double, single, uint32, etc.) is the same as the
24 ## the input class of @var{n}. The algorithm used is the Sieve of 24 ## input class of @var{n}. The algorithm used is the Sieve of Eratosthenes.
25 ## Eratosthenes.
26 ## 25 ##
27 ## Notes: If you need a specific number of primes you can use the 26 ## Notes: If you need a specific number of primes you can use the fact that the
28 ## fact that the distance from one prime to the next is, on average, 27 ## distance from one prime to the next is, on average, proportional to the
29 ## proportional to the logarithm of the prime. Integrating, one finds 28 ## logarithm of the prime. Integrating, one finds that there are about
30 ## that there are about @math{k} primes less than 29 ## @math{k} primes less than
31 ## @tex 30 ## @tex
32 ## $k \log (5 k)$. 31 ## $k \log (5 k)$.
33 ## @end tex 32 ## @end tex
34 ## @ifnottex 33 ## @ifnottex
35 ## k*log (5*k). 34 ## k*log (5*k).
36 ## @end ifnottex 35 ## @end ifnottex
37 ## 36 ##
38 ## See also @code{list_primes} if you need a specific number @var{n} of 37 ## See also @code{list_primes} if you need a specific number @var{n} of primes.
39 ## primes.
40 ## @seealso{list_primes, isprime} 38 ## @seealso{list_primes, isprime}
41 ## @end deftypefn 39 ## @end deftypefn
42 40
43 ## Author: Paul Kienzle 41 ## Author: Paul Kienzle
44 ## Author: Francesco Potortì 42 ## Author: Francesco Potortì