1 # Created by Octave 3.6.1, Tue Apr 03 18:18:25 2012 UTC <root@t61>
13 # name: <cell-element>
17 -- Function File: X = concat (A, B)
18 -- Function File: X = concat (A, B, DIM)
19 Concatenate two matrices regardless of their type. Due to the
20 implementation of the matrix concatenation in Octave being
21 hard-coded for the types it knowns, user types can not use the
22 matrix concatenation operator. Thus for the _Galois_ and _Fixed
23 Point_ types, the in-built matrix concatenation functions will
24 return a matrix value as their solution.
26 This function allows these types to be concatenated. If called
27 with a user type that is not known by this function, the in-built
28 concatenate function is used.
30 If DIM is 1, then the matrices are concatenated, else if DIM is 2,
36 # name: <cell-element>
40 Concatenate two matrices regardless of their type.
44 # name: <cell-element>
51 # name: <cell-element>
55 -- Function File: TABLE = create_lookup_table (X, Y)
56 Creates a lookup table betwen the vectors X and Y. If X is not in
57 increasing order, the vectors are sorted before being stored.
62 # name: <cell-element>
66 Creates a lookup table betwen the vectors X and Y.
70 # name: <cell-element>
77 # name: <cell-element>
81 -- Function File: fixedpoint ('help')
82 -- Function File: fixedpoint ('info')
83 -- Function File: fixedpoint ('info', MOD)
84 -- Function File: fixedpoint ('test')
85 -- Function File: fixedpoint ('test', MOD)
86 Manual and test code for the Octave Fixed Point toolbox. There are
87 5 possible ways to call this function.
90 Display this help message. Called with no arguments, this
91 function also displays this help message
94 Open the Fixed Point toolbox manual
96 `fixedpoint ('info', MOD)'
97 Open the Fixed Point toolbox manual at the section specified
100 `fixedpoint ('test')'
101 Run all of the test code for the Fixed Point toolbox. MOD.
103 Valid values for the varibale MOD are
106 The section describing the use of the fixed point toolbox
110 The section descrining how to use the fixed-point type with
114 The section describing an in-depth example of the use of the
118 The refernce section of all of the specific fixed point
119 operators and functions
121 Please note that this function file should be used as an example
122 of the use of this toolbox.
127 # name: <cell-element>
131 Manual and test code for the Octave Fixed Point toolbox.
135 # name: <cell-element>
142 # name: <cell-element>
146 -- Function File: Y = float (X)
147 Converts a fixed point object to the equivalent floating point
148 object. This is equivalent to `X.x' if `isfixed(X)' returns true,
149 and returns X otherwise.
154 # name: <cell-element>
158 Converts a fixed point object to the equivalent floating point object.
162 # name: <cell-element>
169 # name: <cell-element>
173 -- Function File: [S, I] = fsort (X)
174 Return a copy of the fixed point variable X with the elements
175 arranged in increasing order. For matrices, `fsort' orders the
176 elements in each column.
180 fsort (fixed(4,0,[1, 2; 2, 3; 3, 1]))
185 The `fsort' function may also be used to produce a matrix
186 containing the original row indices of the elements in the sorted
189 [s, i] = sort ([1, 2; 2, 3; 3, 1])
200 # name: <cell-element>
204 Return a copy of the fixed point variable X with the elements arranged
209 # name: <cell-element>
216 # name: <cell-element>
220 -- Function File: Y = lookup_table (TABLE, X)
221 -- Function File: Y = lookup_table (TABLE, X, INTERP, EXTRAP)
222 Using the lookup table created by "create_lookup_table", find the
223 value Y corresponding to X. With two arguments the lookup is done
224 to the nearest value below in the table less than the desired
225 value. With three arguments a simple linear interpolation is
226 performed. With four arguments an extrapolation is also performed.
227 The exact values of arguments three and four are irrelevant, as
228 only there presence detremines whether interpolation and/or
229 extrapolation are used.
234 # name: <cell-element>
238 Using the lookup table created by "create_lookup_table", find the value