1/* Copyright 2016 The TensorFlow Authors. All Rights Reserved.
2
3Licensed under the Apache License, Version 2.0 (the "License");
4you may not use this file except in compliance with the License.
5You may obtain a copy of the License at
6
7 http://www.apache.org/licenses/LICENSE-2.0
8
9Unless required by applicable law or agreed to in writing, software
10distributed under the License is distributed on an "AS IS" BASIS,
11WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12See the License for the specific language governing permissions and
13limitations under the License.
14==============================================================================*/
15
16#ifndef TENSORFLOW_CORE_UTIL_MIRROR_PAD_MODE_H_
17#define TENSORFLOW_CORE_UTIL_MIRROR_PAD_MODE_H_
18
19// This file contains helper routines to deal with padding in various ops and
20// kernels.
21
22#include <string>
23
24#include "tensorflow/core/lib/core/status.h"
25#include "tensorflow/core/lib/core/stringpiece.h"
26
27namespace tensorflow {
28
29// REFLECT: Border elements are not mirrored to padded regions.
30// SYMMETRIC: Border elements are mirrored to padded regions.
31//
32// For example, if two elements are padded to the right of an array [1, 2, 3],
33// then the result is [1, 2, 3, 2, 1] for REFLECT mode, and is [1, 2, 3, 3, 2]
34// for SYMMETRIC mode.
35enum class MirrorPadMode {
36 REFLECT = 1,
37 SYMMETRIC = 2,
38};
39
40// Return the string containing the list of valid padding modes, that can be
41// used as an Attr() in REGISTER_OP.
42string GetMirrorPadModeAttrString();
43
44// Forward declaration to avoid including core/framework/graph.proto.
45class NodeDef;
46
47// Specialization to parse an attribute directly into a MirrorPadMode enum.
48Status GetNodeAttr(const NodeDef& node_def, StringPiece attr_name,
49 MirrorPadMode* value);
50
51} // end namespace tensorflow
52
53#endif // TENSORFLOW_CORE_UTIL_MIRROR_PAD_MODE_H_
54