annotate scripts/general/chop.m @ 20818:9d2023d1a63c

binoinv.m: Implement binary search algorithm for 28X performance increase (bug #34363). * binoinv.m: Call new functions scalar_binoinv or vector_binoinv to calculate binoinv. If there are still uncalculated values then call bin_search_binoinv to perform binary search for remaining values. Add more BIST tests. * binoinv.m (scalar_binoinv): New subfunction to calculate binoinv for scalar x. Stops when x > 1000. * binoinv.m (vector_binoinv): New subfunction to calculate binoinv for scalar x. Stops when x > 1000.
author Lachlan Andrew <lachlanbis@gmail.com>
date Sun, 11 Oct 2015 19:49:40 -0700
parents 7503499a252b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19898
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19827
diff changeset
1 ## Copyright (C) 2010-2015 John W. Eaton
10203
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2 ##
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4 ##
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 ## your option) any later version.
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 ##
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 ##
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10203
diff changeset
20 ## @deftypefn {Function File} {} chop (@var{x}, @var{ndigits}, @var{base})
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10203
diff changeset
21 ## Truncate elements of @var{x} to a length of @var{ndigits} such that the
20368
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19898
diff changeset
22 ## resulting numbers are exactly divisible by @var{base}.
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19898
diff changeset
23 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19898
diff changeset
24 ## If @var{base} is not specified it defaults to 10.
10203
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25 ##
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26 ## @example
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27 ## @group
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28 ## chop (-pi, 5, 10)
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
29 ## @result{} -3.14200000000000
10203
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
30 ## chop (-pi, 5, 5)
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
31 ## @result{} -3.14150000000000
10203
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
32 ## @end group
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 ## @end example
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34 ## @end deftypefn
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10203
diff changeset
36 function retval = chop (x, ndigits, base = 10)
10203
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38 if (nargin == 2 || nargin == 3)
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 tmp = abs (x);
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 ## Avoid computing log (0).
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42 tmp(x == 0) = 1;
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 ## Digits to the left of the decimal.
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45 tmp = floor (log10 (tmp) + 1);
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 ## The expression
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48 ##
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49 ## round (x .* inflate)
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
50 ##
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51 ## produces an integer that contains the digits we want to keep.
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
52 ## Multiplying by deflate puts the decimal back where it belngs.
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
53 ##
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10203
diff changeset
54 ## Further scaling and rounding with the base factor produces a
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10203
diff changeset
55 ## value with ndigits exactly divisible by base. We skip that step
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10203
diff changeset
56 ## unless base was explicitly provided.
10203
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
57
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10203
diff changeset
58 inflate = 10 .^ (ndigits - tmp);
19827
e68267373191 chop.m: Calculate deflate as 1./inflate (bug #43734).
Rik <rik@octave.org>
parents: 17744
diff changeset
59 deflate = 1 ./ inflate;
10203
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 if (nargin == 2)
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
61 retval = deflate .* round (x .* inflate);
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62 else
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10203
diff changeset
63 retval = base .* deflate .* round (round (x .* inflate) ./ base);
10203
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64 endif
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
65 else
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 print_usage ();
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67 endif
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
69 endfunction
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
70
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10203
diff changeset
71
10203
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
72 %!assert (chop (e, 3), 2.72)
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
73 %!assert (chop (e, 4), 2.718)
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
74 %!assert (chop (e, 4, 5), 2.72)
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
75 %!assert (chop (e, 4, 7), 2.716)
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
76 %!assert (chop (-e, 3), -2.72)
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
77 %!assert (chop (-e, 4), -2.718)
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
78 %!assert (chop (-e, 4, 5), -2.72)
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
79 %!assert (chop (-e, 4, 7), -2.716)
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
80 %!assert (chop (hilb (3), 3), [1,.5,.333;.5,.333,.25;.333,.25,.2])
27777bd27e71 general/chop.m: new function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
81 %!assert (chop (hilb (3), 2, 7), [.7,.49,.35;.49,.35,.28;.35,.28,.21], 2*eps)
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
82