Line data    Source code

       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              : #include "neml2/user_tensors/LogspaceTensor.h"
      26              : #include "neml2/misc/assertions.h"
      27              : 
      28              : namespace neml2
      29              : {
      30              : register_NEML2_object(LogspaceTensor);
      31              : 
      32              : OptionSet
      33            2 : LogspaceTensor::expected_options()
      34              : {
      35            2 :   OptionSet options = UserTensorBase::expected_options();
      36            2 :   options.doc() = "Construct a Tensor with exponents linearly spaced on the batch dimensions. "
      37            2 :                   "See neml2::TensorBase::logspace for a detailed explanation.";
      38              : 
      39            4 :   options.set<TensorName<Tensor>>("start");
      40            4 :   options.set("start").doc() = "The starting tensor";
      41              : 
      42            4 :   options.set<TensorName<Tensor>>("end");
      43            4 :   options.set("end").doc() = "The ending tensor";
      44              : 
      45            4 :   options.set<Size>("nstep");
      46            4 :   options.set("nstep").doc() = "The number of steps with even spacing along the new dimension";
      47              : 
      48            4 :   options.set<Size>("dim") = 0;
      49            4 :   options.set("dim").doc() = "Where to insert the new dimension";
      50              : 
      51            4 :   options.set<double>("base") = 10;
      52            4 :   options.set("base").doc() = "Exponent base";
      53              : 
      54            4 :   options.set<Size>("batch_dim") = -1;
      55            2 :   options.set("batch_dim").doc() = "Batch dimension of the output";
      56              : 
      57            6 :   options.set<TensorShape>("batch_expand") = TensorShape();
      58            4 :   options.set("batch_expand").doc() = "After construction, perform an additional batch expanding "
      59            2 :                                       "operation into the given batch shape.";
      60              : 
      61            2 :   return options;
      62            0 : }
      63              : 
      64            1 : LogspaceTensor::LogspaceTensor(const OptionSet & options)
      65              :   : UserTensorBase(options),
      66            1 :     Tensor(make(options))
      67              : {
      68            1 : }
      69              : 
      70              : Tensor
      71            1 : LogspaceTensor::make(const OptionSet & options) const
      72              : {
      73            1 :   auto * f = this->factory();
      74            1 :   neml_assert(f, "Internal error: factory != nullptr");
      75              : 
      76            2 :   auto t = Tensor::logspace(options.get<TensorName<Tensor>>("start").resolve(f),
      77            2 :                             options.get<TensorName<Tensor>>("end").resolve(f),
      78              :                             options.get<Size>("nstep"),
      79            8 :                             options.get<Size>("dim"));
      80              : 
      81              :   // Change batch dimension if requested
      82            1 :   auto B = options.get<Size>("batch_dim");
      83            1 :   if (B >= 0)
      84            0 :     t = Tensor(t, B);
      85              : 
      86              :   // Expand if requested
      87            1 :   auto S = options.get<TensorShape>("batch_expand");
      88            1 :   if (!S.empty())
      89            0 :     t = t.batch_expand(S);
      90              : 
      91            2 :   return t;
      92            1 : }
      93              : } // namespace neml2