LogspaceFixedDimTensor.cxx

// Copyright 2023, UChicago Argonne, LLC
// All Rights Reserved
// Software Name: NEML2 -- the New Engineering material Model Library, version 2
// By: Argonne National Laboratory
// OPEN SOURCE LICENSE (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#include "neml2/tensors/user_tensors/LogspaceFixedDimTensor.h"
 
namespace neml2
{
#define LOGSPACEFIXEDDIMTENSOR_REGISTER(T) register_NEML2_object_alias(Logspace##T, "Logspace" #T)
FOR_ALL_FIXEDDIMTENSOR(LOGSPACEFIXEDDIMTENSOR_REGISTER);
 
template <typename T>
OptionSet
LogspaceFixedDimTensor<T>::expected_options()
{
  // This is the only way of getting tensor type in a static method like this...
  // Trim 6 chars to remove 'neml2::'
  auto tensor_type = utils::demangle(typeid(T).name()).substr(7);
 
  OptionSet options = UserTensor::expected_options();
  options.doc() = "Construct a " + tensor_type +
                  " with exponents linearly spaced on the batch dimensions. See "
                  "neml2::BatchTensorBase::logspace for a detailed explanation.";
 
  options.set<CrossRef<T>>("start");
  options.set("start").doc() = "The starting tensor";
 
  options.set<CrossRef<T>>("end");
  options.set("end").doc() = "The ending tensor";
 
  options.set<TorchSize>("nstep");
  options.set("nstep").doc() = "The number of steps with even spacing along the new dimension";
 
  options.set<TorchSize>("dim") = 0;
  options.set("dim").doc() = "Where to insert the new dimension";
 
  options.set<TorchSize>("batch_dim") = -1;
  options.set("batch_dim").doc() = "Batch dimension of the output";
 
  options.set<Real>("base") = 10;
  options.set("base").doc() = "Exponent base";
 
  return options;
}
 
template <typename T>
LogspaceFixedDimTensor<T>::LogspaceFixedDimTensor(const OptionSet & options)
  : T(T::logspace(options.get<CrossRef<T>>("start"),
                  options.get<CrossRef<T>>("end"),
                  options.get<TorchSize>("nstep"),
                  options.get<TorchSize>("dim"),
                  options.get<TorchSize>("batch_dim"),
                  options.get<Real>("base"))),
    UserTensor(options)
{
}
 
#define LOGSPACEFIXEDDIMTENSOR_INSTANTIATE_FIXEDDIMTENSOR(T)                                       \
  template class LogspaceFixedDimTensor<T>
FOR_ALL_FIXEDDIMTENSOR(LOGSPACEFIXEDDIMTENSOR_INSTANTIATE_FIXEDDIMTENSOR);
} // namespace neml2