NEML2 2.0.0
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
TraceableTensorShape.h
1// Copyright 2024, UChicago Argonne, LLC
2// All Rights Reserved
3// Software Name: NEML2 -- the New Engineering material Model Library, version 2
4// By: Argonne National Laboratory
5// OPEN SOURCE LICENSE (MIT)
6//
7// Permission is hereby granted, free of charge, to any person obtaining a copy
8// of this software and associated documentation files (the "Software"), to deal
9// in the Software without restriction, including without limitation the rights
10// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11// copies of the Software, and to permit persons to whom the Software is
12// furnished to do so, subject to the following conditions:
13//
14// The above copyright notice and this permission notice shall be included in
15// all copies or substantial portions of the Software.
16//
17// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23// THE SOFTWARE.
24
25#pragma once
26
27#include "neml2/jit/TraceableSize.h"
28
29namespace neml2
30{
37struct TraceableTensorShape : public SmallVector<TraceableSize, 8>
38{
40 using Size = int64_t;
41
42 TraceableTensorShape(const TensorShape & shape);
45 TraceableTensorShape(const ATensor & shape);
46
48 TraceableTensorShape slice(Size start, Size end) const;
49
52
54 TensorShape concrete() const;
55
57 ATensor as_tensor() const;
58};
59
62bool operator==(const TraceableTensorShape & lhs, const TraceableTensorShape & rhs);
63bool operator!=(const TraceableTensorShape & lhs, const TraceableTensorShape & rhs);
65} // namespace neml2
Definition DiagnosticsInterface.cxx:30
c10::SmallVector< Size, 8 > TensorShape
Definition types.h:71
c10::SmallVector< T, N > SmallVector
Definition types.h:60
at::Tensor ATensor
Definition types.h:42
bool operator==(const LabeledAxis &a, const LabeledAxis &b)
Definition LabeledAxis.cxx:503
bool operator!=(const LabeledAxis &a, const LabeledAxis &b)
Definition LabeledAxis.cxx:509
c10::ArrayRef< Size > TensorShapeRef
Definition types.h:72
Traceable size.
Definition TraceableSize.h:40
Traceable tensor shape.
Definition TraceableTensorShape.h:38
TensorShape concrete() const
Definition TraceableTensorShape.cxx:78
TraceableTensorShape(const TensorShape &shape)
Definition TraceableTensorShape.cxx:32
int64_t Size
Definition TraceableTensorShape.h:40
TraceableTensorShape slice(Size start, Size end) const
Slice the shape, semantically the same as ArrayRef::slice, but traceable.
Definition TraceableTensorShape.cxx:59
ATensor as_tensor() const
Definition TraceableTensorShape.cxx:87