NEML2 1.4.0
Loading...
Searching...
No Matches
LinspaceBatchTensor.cxx
1// Copyright 2023, 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#include "neml2/tensors/user_tensors/LinspaceBatchTensor.h"
26#include "neml2/base/CrossRef.h"
27
28namespace neml2
29{
30register_NEML2_object(LinspaceBatchTensor);
31
34{
36 options.doc() = "Construct a BatchTensor linearly spaced on the batch dimensions. See "
37 "neml2::BatchTensorBase::linspace for a detailed explanation.";
38
39 options.set<CrossRef<BatchTensor>>("start");
40 options.set("start").doc() = "The starting tensor";
41
42 options.set<CrossRef<BatchTensor>>("end");
43 options.set("end").doc() = "The ending tensor";
44
45 options.set<TorchSize>("nstep");
46 options.set("nstep").doc() = "The number of steps with even spacing along the new dimension";
47
48 options.set<TorchSize>("dim") = 0;
49 options.set("dim").doc() = "Where to insert the new dimension";
50
51 options.set<TorchSize>("batch_dim") = -1;
52 options.set("batch_dim").doc() = "Batch dimension of the output";
53
54 options.set<TorchShape>("batch_expand") = TorchShape();
55 options.set("batch_expand").doc() = "After construction, perform an additional batch expanding "
56 "operation into the given batch shape.";
57
58 return options;
59}
60
62 : BatchTensor(BatchTensor::linspace(options.get<CrossRef<BatchTensor>>("start"),
63 options.get<CrossRef<BatchTensor>>("end"),
64 options.get<TorchSize>("nstep"),
65 options.get<TorchSize>("dim"),
66 options.get<TorchSize>("batch_dim"))),
67 UserTensor(options)
68{
69 auto bs = options.get<TorchShape>("batch_expand");
70 if (bs.size() > 0)
71 this->batch_expand(bs);
72}
73} // namespace neml2
BatchTensor batch_expand(TorchShapeRef batch_size) const
Return a new view of the tensor with values broadcast along the batch dimensions.
Definition BatchTensorBase.cxx:219
Definition BatchTensor.h:32
The wrapper (decorator) for cross-referencing unresolved values at parse time.
Definition CrossRef.h:52
Create a linspace BatchTensor from the input file.
Definition LinspaceBatchTensor.h:37
LinspaceBatchTensor(const OptionSet &options)
Construct a new LinspaceBatchTensor object.
Definition LinspaceBatchTensor.cxx:61
static OptionSet expected_options()
Definition LinspaceBatchTensor.cxx:33
A custom map-like data structure. The keys are strings, and the values can be nonhomogeneously typed.
Definition OptionSet.h:59
const std::string & doc() const
A readonly reference to the option set's docstring.
Definition OptionSet.h:91
const T & get(const std::string &) const
Definition OptionSet.h:422
T & set(const std::string &)
Definition OptionSet.h:436
Definition UserTensor.h:33
static OptionSet expected_options()
Definition UserTensor.cxx:30
Definition CrossRef.cxx:32
std::vector< TorchSize > TorchShape
Definition types.h:34