aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/g3doc/api_docs/cc/ClassTensorShape.md
blob: 47a105a76e23033f8e4168094b840719e66f0c06 (plain)
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
#Class tensorflow::TensorShape

Manages the dimensions of a Tensor and their sizes.



##Member Summary

* [tensorflow::TensorShape::TensorShape](#tensorflow_TensorShape_TensorShape)
  * Construct a TensorShape from the provided sizes.. REQUIRES: dim_sizes[i] >= 0.
* [tensorflow::TensorShape::TensorShape](#tensorflow_TensorShape_TensorShape)
* [tensorflow::TensorShape::TensorShape](#tensorflow_TensorShape_TensorShape)
  * REQUIRES: IsValid(proto)
* [tensorflow::TensorShape::TensorShape](#tensorflow_TensorShape_TensorShape)
* [void tensorflow::TensorShape::Clear](#void_tensorflow_TensorShape_Clear)
  * Clear a tensor shape.
* [void tensorflow::TensorShape::AddDim](#void_tensorflow_TensorShape_AddDim)
  * Add a dimension to the end ("inner-most"). REQUIRES: size >= 0.
* [void tensorflow::TensorShape::AppendShape](#void_tensorflow_TensorShape_AppendShape)
  * Appends all the dimensions from shape.
* [void tensorflow::TensorShape::InsertDim](#void_tensorflow_TensorShape_InsertDim)
  * Insert a dimension somewhere in the TensorShape . REQUIRES: "0 <= d <= dims()" REQUIRES: size >= 0.
* [void tensorflow::TensorShape::set_dim](#void_tensorflow_TensorShape_set_dim)
  * Modifies the size of the dimension 'd' to be 'size' REQUIRES: "0 <= d < dims()" REQUIRES: size >= 0.
* [void tensorflow::TensorShape::RemoveDim](#void_tensorflow_TensorShape_RemoveDim)
  * Removes dimension 'd' from the TensorShape . REQUIRES: "0 <= d < dims()".
* [int tensorflow::TensorShape::dims](#int_tensorflow_TensorShape_dims)
  * Return the number of dimensions in the tensor.
* [int64 tensorflow::TensorShape::dim_size](#int64_tensorflow_TensorShape_dim_size)
  * Returns the number of elements in dimension "d". REQUIRES: "0 <= d < dims()".
* [gtl::ArraySlice<int64> tensorflow::TensorShape::dim_sizes](#gtl_ArraySlice_lt_int64_gt_tensorflow_TensorShape_dim_sizes)
  * Returns sizes of all dimensions.
* [int64 tensorflow::TensorShape::num_elements](#int64_tensorflow_TensorShape_num_elements)
  * Returns the number of elements in the tensor.
* [bool tensorflow::TensorShape::IsSameSize](#bool_tensorflow_TensorShape_IsSameSize)
  * Returns true if *this and b have the same sizes. Ignores dimension names.
* [bool tensorflow::TensorShape::operator==](#bool_tensorflow_TensorShape_operator_)
* [void tensorflow::TensorShape::AsProto](#void_tensorflow_TensorShape_AsProto)
  * Fill *proto from *this.
* [Eigen::DSizes< Eigen::DenseIndex, NDIMS > tensorflow::TensorShape::AsEigenDSizes](#Eigen_DSizes_lt_Eigen_DenseIndex_NDIMS_gt_tensorflow_TensorShape_AsEigenDSizes)
  * Fill *dsizes from *this.
* [Eigen::DSizes< Eigen::DenseIndex, NDIMS > tensorflow::TensorShape::AsEigenDSizesWithPadding](#Eigen_DSizes_lt_Eigen_DenseIndex_NDIMS_gt_tensorflow_TensorShape_AsEigenDSizesWithPadding)
* [TensorShapeIter tensorflow::TensorShape::begin](#TensorShapeIter_tensorflow_TensorShape_begin)
  * For iterating through the dimensions.
* [TensorShapeIter tensorflow::TensorShape::end](#TensorShapeIter_tensorflow_TensorShape_end)
* [string tensorflow::TensorShape::DebugString](#string_tensorflow_TensorShape_DebugString)
  * For error messages.
* [string tensorflow::TensorShape::ShortDebugString](#string_tensorflow_TensorShape_ShortDebugString)
* [static bool tensorflow::TensorShape::IsValid](#static_bool_tensorflow_TensorShape_IsValid)
  * Returns true iff "proto" is a valid tensor shape.

##Member Details

#### tensorflow::TensorShape::TensorShape(gtl::ArraySlice< int64 > dim_sizes) {#tensorflow_TensorShape_TensorShape}

Construct a TensorShape from the provided sizes.. REQUIRES: dim_sizes[i] >= 0.



#### tensorflow::TensorShape::TensorShape(std::initializer_list< int64 > dim_sizes) {#tensorflow_TensorShape_TensorShape}





#### tensorflow::TensorShape::TensorShape(const TensorShapeProto &proto) {#tensorflow_TensorShape_TensorShape}

REQUIRES: IsValid(proto)



#### tensorflow::TensorShape::TensorShape() {#tensorflow_TensorShape_TensorShape}



Create a tensor shape with no dimensions and one element, which you can then call AddDim() on.

#### void tensorflow::TensorShape::Clear() {#void_tensorflow_TensorShape_Clear}

Clear a tensor shape.



#### void tensorflow::TensorShape::AddDim(int64 size) {#void_tensorflow_TensorShape_AddDim}

Add a dimension to the end ("inner-most"). REQUIRES: size >= 0.



#### void tensorflow::TensorShape::AppendShape(const TensorShape &shape) {#void_tensorflow_TensorShape_AppendShape}

Appends all the dimensions from shape.



#### void tensorflow::TensorShape::InsertDim(int d, int64 size) {#void_tensorflow_TensorShape_InsertDim}

Insert a dimension somewhere in the TensorShape . REQUIRES: "0 <= d <= dims()" REQUIRES: size >= 0.



#### void tensorflow::TensorShape::set_dim(int d, int64 size) {#void_tensorflow_TensorShape_set_dim}

Modifies the size of the dimension 'd' to be 'size' REQUIRES: "0 <= d < dims()" REQUIRES: size >= 0.



#### void tensorflow::TensorShape::RemoveDim(int d) {#void_tensorflow_TensorShape_RemoveDim}

Removes dimension 'd' from the TensorShape . REQUIRES: "0 <= d < dims()".



#### int tensorflow::TensorShape::dims() const {#int_tensorflow_TensorShape_dims}

Return the number of dimensions in the tensor.



#### int64 tensorflow::TensorShape::dim_size(int d) const {#int64_tensorflow_TensorShape_dim_size}

Returns the number of elements in dimension "d". REQUIRES: "0 <= d < dims()".



#### gtl::ArraySlice<int64> tensorflow::TensorShape::dim_sizes() const {#gtl_ArraySlice_lt_int64_gt_tensorflow_TensorShape_dim_sizes}

Returns sizes of all dimensions.



#### int64 tensorflow::TensorShape::num_elements() const {#int64_tensorflow_TensorShape_num_elements}

Returns the number of elements in the tensor.

We use int64 and not size_t to be compatible with Eigen::Tensor which uses ptr_fi

#### bool tensorflow::TensorShape::IsSameSize(const TensorShape &b) const {#bool_tensorflow_TensorShape_IsSameSize}

Returns true if *this and b have the same sizes. Ignores dimension names.



#### bool tensorflow::TensorShape::operator==(const TensorShape &b) const {#bool_tensorflow_TensorShape_operator_}





#### void tensorflow::TensorShape::AsProto(TensorShapeProto *proto) const {#void_tensorflow_TensorShape_AsProto}

Fill *proto from *this.



#### Eigen::DSizes< Eigen::DenseIndex, NDIMS > tensorflow::TensorShape::AsEigenDSizes() const {#Eigen_DSizes_lt_Eigen_DenseIndex_NDIMS_gt_tensorflow_TensorShape_AsEigenDSizes}

Fill *dsizes from *this.



#### Eigen::DSizes< Eigen::DenseIndex, NDIMS > tensorflow::TensorShape::AsEigenDSizesWithPadding() const {#Eigen_DSizes_lt_Eigen_DenseIndex_NDIMS_gt_tensorflow_TensorShape_AsEigenDSizesWithPadding}



Same as AsEigenDSizes() but allows for NDIMS > dims()  in which case we pad the rest of the sizes with 1.

#### TensorShapeIter tensorflow::TensorShape::begin() const {#TensorShapeIter_tensorflow_TensorShape_begin}

For iterating through the dimensions.



#### TensorShapeIter tensorflow::TensorShape::end() const {#TensorShapeIter_tensorflow_TensorShape_end}





#### string tensorflow::TensorShape::DebugString() const {#string_tensorflow_TensorShape_DebugString}

For error messages.



#### string tensorflow::TensorShape::ShortDebugString() const {#string_tensorflow_TensorShape_ShortDebugString}





#### static bool tensorflow::TensorShape::IsValid(const TensorShapeProto &proto) {#static_bool_tensorflow_TensorShape_IsValid}

Returns true iff "proto" is a valid tensor shape.