tensorflow/tensorflow/core/util/strided_slice_op.cc at master · codeplaysoftware/tensorflow · GitHub

Repository navigation

History

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

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

==============================================================================*/

#include "tensorflow/core/util/strided_slice_op.h"

#include <array>

#include "tensorflow/core/kernels/bounds_check.h"

#include "tensorflow/core/lib/core/status.h"

namespace tensorflow {

namespace {

/// Constants

constexpr int32 kShrinkAxis = -1, kNewAxis = -2;

// Sparse slicing specification

// if one does foo[3:5, ..., -3], this will have 3 length tensors

struct StridedSliceSparseSpec {

int64 dims;

int32 num_add_axis_after_ellipsis;

const Tensor* begin_tensor;

const Tensor* end_tensor;

const Tensor& strides_tensor;

const int32 begin_mask, end_mask;

int32 ellipsis_mask;

const int32 new_axis_mask, shrink_axis_mask;

};

// Dense slicing specification

// all ellipses and newaxis' are expanded out. So if

// foo[3:5, ..., -3] where foo is 10 dimensional,

// each inlinedVector will have 10 entries whereas the

// sparse had 3 length tensors.

struct StridedSliceDenseSpec {

const int64 dims;

int32 begin_mask;

int32 end_mask;

bool begin_valid;

bool end_valid;

gtl::InlinedVector<int64, 4>& begin;

gtl::InlinedVector<int64, 4>& end;

gtl::InlinedVector<int64, 4>& strides;

// This vector helps construct the final shape of the slice.

// The final tensor is reduced in rank whenever a single index e.g. foo[3]

// is called for. The final tensor increases in rank with tf.newaxis

// entries. If an index in this array is positive, the size of the dimension

// is obtained from canonical end-begin. Otherwise, if it is a kNewAxis,

// it will be 1. A shrunk dimension is skipped.

gtl::InlinedVector<int32, 4> final_shape_gather_indices;

// The dense indexed shrink mask is which processing dimensions

// should be shrunk. For example, if foo.shape = (10,10,10,10)

// foo[3, ..., 5] has sparse_shrink_axis_mask of 0x5 and

// dense_shrink_axis_mask of 0x9, yielding a final shape (10,10).

int32 shrink_axis_mask;

};

} // namespace

template <class T>

static Status TF_MUST_USE_RESULT BuildDenseSpec(

const StridedSliceSparseSpec& sparse, StridedSliceDenseSpec* dense) {

// Build expanded begin, end, strides, begin_mask, end_mask

// to remove any ellipsis

dense->begin.resize(dense->dims);

dense->end.resize(dense->dims);

dense->strides.resize(dense->dims);

// What indices to get the final shape from.

dense->begin_mask = 0;

dense->end_mask = 0;

dense->shrink_axis_mask = 0;

{

int full_index = 0;

const auto& strides_flat = sparse.strides_tensor.flat<T>();

dense->begin_valid = sparse.begin_tensor != nullptr;

dense->end_valid = sparse.end_tensor != nullptr;

for (int i = 0; i < sparse.dims; i++) {

if ((1 << i) & sparse.ellipsis_mask) {

// Expand the ellipsis into the appropriate indices

// NOTE: this only works because we guaranteed one ellipsis

int32 next_index = std::min(dense->dims - (sparse.dims - i) + 1 +

sparse.num_add_axis_after_ellipsis,

dense->dims);

for (; full_index < next_index; full_index++) {

// new_axis' aren't real axis so you have to skip

dense->begin[full_index] = dense->end[full_index] = 0;

dense->strides[full_index] = 1;

dense->begin_mask |= (1 << full_index);

dense->end_mask |= (1 << full_index);

dense->final_shape_gather_indices.push_back(full_index);

}

} else if ((1 << i) & sparse.new_axis_mask) {

dense->final_shape_gather_indices.push_back(kNewAxis);

} else {

if (full_index == dense->begin.size()) {

return errors::InvalidArgument("Index out of range using input dim ",

full_index, "; input has only ",

dense->dims, " dims");

}

// Gather slicing spec into appropriate index

if (sparse.begin_tensor != nullptr) {

const auto& begin_flat = sparse.begin_tensor->flat<T>();

dense->begin[full_index] = internal::SubtleMustCopy<T>(begin_flat(i));

}

if (sparse.end_tensor != nullptr) {

const auto& end_flat = sparse.end_tensor->flat<T>();

dense->end[full_index] = internal::SubtleMustCopy<T>(end_flat(i));

}

dense->strides[full_index] =

internal::SubtleMustCopy<T>(strides_flat(i));

if (sparse.begin_mask & (1 << i)) {

dense->begin_mask |= (1 << full_index);

}

if (sparse.end_mask & (1 << i)) {

dense->end_mask |= (1 << full_index);

}

// If shrink, record where to get the dimensionality from (i.e.

// new_axis creates a fake 1 size dimension. Also remember shrink

// axis (now in dense form) so we can ignore dense->end below.

if (sparse.shrink_axis_mask & (1 << i)) {

dense->final_shape_gather_indices.push_back(kShrinkAxis);

dense->shrink_axis_mask |= (1 << full_index);

} else {

dense->final_shape_gather_indices.push_back(full_index);

}

full_index++;

}

return Status::OK();

}

Status ValidateStridedSliceOp(

const Tensor* begin_tensor, const Tensor* end_tensor,

const Tensor& strides_tensor, const PartialTensorShape& input_shape,

int32 begin_mask_spec, int32 end_mask_spec, const int32 ellipsis_mask,

int32 new_axis_mask, int32 shrink_axis_mask,

PartialTensorShape* processing_shape, PartialTensorShape* final_shape,

bool* is_identity, bool* is_simple_slice, bool* slice_dim0,

gtl::InlinedVector<int64, 4>* begin, gtl::InlinedVector<int64, 4>* end,

gtl::InlinedVector<int64, 4>* strides) {

const bool begin_is_wrong =

begin_tensor != nullptr &&

!(TensorShapeUtils::IsVector(begin_tensor->shape()) &&

begin_tensor->NumElements() == strides_tensor.NumElements() &&

begin_tensor->NumElements() < 32 /* using 32 bit masks */);

const bool end_is_wrong =

end_tensor != nullptr &&

!(TensorShapeUtils::IsVector(end_tensor->shape()) &&

end_tensor->NumElements() == strides_tensor.NumElements());

if (begin_is_wrong || end_is_wrong ||

!TensorShapeUtils::IsVector(strides_tensor.shape())) {

if (begin_tensor != nullptr && end_tensor != nullptr) {

return errors::InvalidArgument(

"Expected begin, end, and strides to be 1D equal size tensors, ",

"but got shapes ", begin_tensor->shape().DebugString(), ", ",

end_tensor->shape().DebugString(), ", and ",

strides_tensor.shape().DebugString(), " instead.");

} else {

return errors::InvalidArgument(

"Expected begin, end, and strides to be 1D equal size tensors, ",

"but got shape ", strides_tensor.shape().DebugString(),

" for strides.");

}

// Use bit compares to ensure ellipsis_mask is 0 or a power of 2

// i.e. there exists only no more than one ellipsis

if (ellipsis_mask && ((ellipsis_mask & (ellipsis_mask - 1)) != 0)) {

return errors::InvalidArgument(

"Multiple ellipses in slice spec not allowed");

}

// Step 1: Account for ellipsis and new axis

// Check for ellipses and count how many non-newaxis' there are after

// TODO(aselle): Convert this to do a fast log2 followed by iteration

// counting ones in next guys

bool ellipsis_seen = false;

StridedSliceSparseSpec sparse_spec = {strides_tensor.NumElements(),

begin_tensor,

end_tensor,

strides_tensor,

begin_mask_spec,

end_mask_spec,

ellipsis_mask,

new_axis_mask,

shrink_axis_mask};

for (int32 i = 0; i < sparse_spec.dims; i++) {

if (ellipsis_seen && ((1 << i) & new_axis_mask) != 0) {

sparse_spec.num_add_axis_after_ellipsis++;

}

if ((1 << i) & ellipsis_mask) {

ellipsis_seen = true;

}

// If no ellipsis insert one at the end

if (!ellipsis_seen) {

sparse_spec.ellipsis_mask |= (1 << sparse_spec.dims);

sparse_spec.dims++; // this effects loop iteration below

}

// Step 2: Make a sparse spec into a full index spec

// The sparse spec does not correspond to the number of dimensions

// Make a dense spec that corresponds to the number of dimensions

// For example suppose foo[...,3:] on foo.shape=(2,2,3) then

// we need to produce the missing begin_mask for the first two

// dimensions i.e. from begin_mask_spec=0, end_mask_spec=2

// we achieve begin_mask=6, end_mask=7

StridedSliceDenseSpec dense_spec = {input_shape.dims(),

0 /* begin_mask */,

0 /* end_mask */,

false /* begin_valid */,

false /* end_valid */,

*begin,

*end,

*strides};

if (strides_tensor.dtype() == DT_INT32) {

TF_RETURN_IF_ERROR(BuildDenseSpec<int32>(sparse_spec, &dense_spec));

} else if (strides_tensor.dtype() == DT_INT64) {

TF_RETURN_IF_ERROR(BuildDenseSpec<int64>(sparse_spec, &dense_spec));

} else {

LOG(FATAL) << "begin must be either int32 or int64";

}

// Step 3: Make implicit ranges (non-zero begin_masks and end_masks) explicit

// and bounds check!

*is_identity = true;

*slice_dim0 = true;

*is_simple_slice = true;

processing_shape->Clear();

for (int i = 0; i < input_shape.dims(); ++i) {

int64& begin_i = (*begin)[i];

int64& end_i = (*end)[i];

int64& stride_i = (*strides)[i];

int64 dim_i = input_shape.dim_size(i);

if (stride_i == 0) {

return errors::InvalidArgument("strides[", i, "] must be non-zero");

}

bool shrink_i = (dense_spec.shrink_axis_mask & (1 << i));

if (dim_i == -1) {

processing_shape->AddDim(shrink_i ? 1 : -1);

continue;

}

const std::array<int64, 2> masks = {

{dense_spec.begin_mask & (1 << i), dense_spec.end_mask & (1 << i)}};

const std::array<int64, 2> valid_range = {

{stride_i > 0 ? 0 : -1, stride_i > 0 ? dim_i : dim_i - 1}};

auto canonical = [stride_i, i, dim_i, masks, valid_range](int64 x, int c) {

if (masks[c]) {

return stride_i > 0 ? valid_range[c] : valid_range[(c + 1) & 1];

} else {

int64 x_fwd = x < 0 ? dim_i + x : x; // make negative indices positive

return x_fwd < valid_range[0]

? valid_range[0]

: x_fwd > valid_range[1] ? valid_range[1] : x_fwd;

}

};

if (shrink_i && stride_i <= 0) {

return errors::InvalidArgument(

"only stride 1 allowed on non-range indexing.");

}

(*is_simple_slice) &= stride_i == 1;

const bool begin_and_end_masked =

(dense_spec.begin_mask & (1 << i)) && (dense_spec.end_mask & (1 << i));

if (dense_spec.begin_valid && dense_spec.end_valid) {

if (shrink_i) {

// If we are shrinking, the end index is now possibly incorrect. In

// particular foo[-1] produces sparse_begin = -1, sparse_end = 0.

// and canonical puts these to n-1 and 0, which implies a degenerate

// interval. Fortunately, it is now safe to re-create end as begin+1.

int64 x_fwd = begin_i < 0 ? dim_i + begin_i : begin_i;

begin_i = x_fwd;

end_i = begin_i + 1;

if (x_fwd < 0 || x_fwd >= dim_i) {

return errors::InvalidArgument(

"slice index ", begin_i, " of dimension ", i, " out of bounds.");

}

} else {

begin_i = canonical(begin_i, 0);

end_i = canonical(end_i, 1);

}

// Update optimization values

bool take_all_in_dimension =

stride_i == 1 && begin_i == 0 && end_i == dim_i;

(*is_identity) &= take_all_in_dimension;

(*slice_dim0) &= (i == 0 && stride_i == 1) || take_all_in_dimension;

} else {

(*is_identity) &= stride_i == 1 && begin_and_end_masked;

(*slice_dim0) &= (i == 0 && stride_i == 1) || begin_and_end_masked;

}

// Compute the processing shape (the intermediate Eigen will produce)

int64 interval_length;

bool known_interval = false;

if (dense_spec.begin_valid && dense_spec.end_valid) {

interval_length = end_i - begin_i;

known_interval = true;

} else if (shrink_i) {

// The dimension is still known as 1 for the processing_shape, but will be

// discarded for the final shape.

interval_length = 1;

known_interval = true;

} else if (begin_and_end_masked) {

// Even if we don't have values for begin or end, we do know that this

// dimension covers the whole interval. If we have shape information for

// this dimension, that tells us the interval length.

if (dim_i > 0) {

if (stride_i < 0) {

interval_length = -dim_i;

} else {

interval_length = dim_i;

}

known_interval = true;

}

if (known_interval) {

int64 size_i;

// Hold zero if the interval is degenerate, otherwise account for

// remainder

if (interval_length == 0 || ((interval_length < 0) != (stride_i < 0))) {

size_i = 0;

} else {

size_i = interval_length / stride_i +

(interval_length % stride_i != 0 ? 1 : 0);

}

processing_shape->AddDim(size_i);

} else {

processing_shape->AddDim(-1);

}

// Step 4: Compute the final shape

// new_axis will increase dimension by 1 (with a one-size dimension)

// slices like foo[3,...] will reduce dimension by 1.

// This cannot be done earlier, because it depends on Step 3.

final_shape->Clear();

for (auto gather_index : dense_spec.final_shape_gather_indices) {

if (gather_index >= 0) {

final_shape->AddDim(processing_shape->dim_size(gather_index));

} else if (gather_index == kNewAxis) {

final_shape->AddDim(1);

}

return Status::OK();

}

Status ValidateStridedSliceOp(

const Tensor* begin_tensor, const Tensor* end_tensor,

const Tensor& strides_tensor, const PartialTensorShape& input_shape,

int32 begin_mask_spec, int32 end_mask_spec, const int32 ellipsis_mask,

int32 new_axis_mask, int32 shrink_axis_mask, TensorShape* processing_shape,

TensorShape* final_shape, bool* is_identity, bool* is_simple_slice,

bool* slice_dim0, gtl::InlinedVector<int64, 4>* begin,

gtl::InlinedVector<int64, 4>* end, gtl::InlinedVector<int64, 4>* strides) {

// Validate with PartialTensorShape output

PartialTensorShape partial_processing_shape, partial_final_shape;

TF_RETURN_IF_ERROR(ValidateStridedSliceOp(

begin_tensor, end_tensor, strides_tensor, input_shape, begin_mask_spec,

end_mask_spec, ellipsis_mask, new_axis_mask, shrink_axis_mask,

&partial_processing_shape, &partial_final_shape, is_identity,

is_simple_slice, slice_dim0, begin, end, strides));

// Verify that the output shapes are fully known

if (!partial_processing_shape.AsTensorShape(processing_shape) ||

!partial_final_shape.AsTensorShape(final_shape)) {

return errors::Internal("ValidateStridedSliceOp returned partial shapes ",

partial_processing_shape.DebugString(), " and ",

partial_final_shape.DebugString());

}

return Status::OK();

}

} // namespace tensorflow

tensorflow/tensorflow/core/util/strided_slice_op.cc at master · codeplaysoftware/tensorflow · GitHub

Repository navigation

Expand file tree

Breadcrumbs

strided_slice_op.cc

Latest commit

History

Breadcrumbs

strided_slice_op.cc

File metadata and controls