1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
/*
* Copyright (c) 2009 Samit Basu
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#include "Array.hpp"
#include "Utils.hpp"
//!
//@Module RESHAPE Reshape An Array
//@@Section ARRAY
//@@Usage
//Reshapes an array from one size to another. Two seperate
//syntaxes are possible. The first syntax specifies the array
//dimensions as a sequence of scalar dimensions:
//@[
// y = reshape(x,d1,d2,...,dn).
//@]
//The resulting array has the given dimensions, and is filled with
//the contents of @|x|. The type of @|y| is the same as @|x|.
//The second syntax specifies the array dimensions as a vector,
//where each element in the vector specifies a dimension length:
//@[
// y = reshape(x,[d1,d2,...,dn]).
//@]
//This syntax is more convenient for calling @|reshape| using a
//variable for the argument. The
//@|reshape| function requires that the length of @|x| equal the product
//of the @|di| values.
//Note that arrays are stored in column format,
//which means that elements in @|x| are transferred to the new array
//@|y| starting with the first column first element, then proceeding to
//the last element of the first column, then the first element of the
//second column, etc.
//@@Example
//Here are several examples of the use of @|reshape| applied to
//various arrays. The first example reshapes a row vector into a
//matrix.
//@<
//a = uint8(1:6)
//reshape(a,2,3)
//@>
//The second example reshapes a longer row vector into a volume with
//two planes.
//@<
//a = uint8(1:12)
//reshape(a,[2,3,2])
//@>
//The third example reshapes a matrix into another matrix.
//@<
//a = [1,6,7;3,4,2]
//reshape(a,3,2)
//@>
//@@Tests
//@{ test_reshape1.m
//function test_val = test_reshape1
// a = [1,6,7;3,4,2];
// b = [1,4;3,7;6,2];
// c = reshape(a,3,2);
// test_val = issame(b,c);
//@}
//@@Signature
//function reshape ReshapeFunction
//inputs x varargin
//outputs y
//!
ArrayVector ReshapeFunction(int nargout, const ArrayVector& arg) {
if (arg.size() == 0)
throw Exception("reshape function requires at least one argument");
if (arg.size() == 1) return arg;
ArrayVector arg_copy(arg);
arg_copy.pop_front();
NTuple dims(ArrayVectorAsDimensions(arg_copy));
Array y(arg[0]);
y.reshape(dims);
return ArrayVector(y);
}
|
