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

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 9fc020886ae9
children
comparison
equal deleted inserted replaced
20160:03b9d17a2d95 20162:2645f9ef8c88
17 ## along with Octave; see the file COPYING. If not, see 17 ## along with Octave; see the file COPYING. If not, see
18 ## <http://www.gnu.org/licenses/>. 18 ## <http://www.gnu.org/licenses/>.
19 19
20 ## -*- texinfo -*- 20 ## -*- texinfo -*-
21 ## @deftypefn {Function File} {} isprime (@var{x}) 21 ## @deftypefn {Function File} {} isprime (@var{x})
22 ## Return a logical array which is true where the elements of @var{x} are 22 ## Return a logical array which is true where the elements of @var{x} are prime
23 ## prime numbers and false where they are not. 23 ## numbers and false where they are not.
24 ## 24 ##
25 ## A prime number is conventionally defined as a positive integer greater than 25 ## A prime number is conventionally defined as a positive integer greater than
26 ## 1 (e.g., 2, 3, @dots{}) which is divisible only by itself and 1. Octave 26 ## 1 (e.g., 2, 3, @dots{}) which is divisible only by itself and 1. Octave
27 ## extends this definition to include both negative integers and complex 27 ## extends this definition to include both negative integers and complex
28 ## values. A negative integer is prime if its positive counterpart is prime. 28 ## values. A negative integer is prime if its positive counterpart is prime.