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/EmptyPrimitiveTensor.h"
      26              : #include "neml2/tensors/tensors.h"
      27              : 
      28              : namespace neml2
      29              : {
      30              : template <typename T>
      31              : OptionSet
      32           44 : EmptyPrimitiveTensor<T>::expected_options()
      33              : {
      34              :   // This is the only way of getting tensor type in a static method like this...
      35              :   // Trim 6 chars to remove 'neml2::'
      36           44 :   auto tensor_type = utils::demangle(typeid(T).name()).substr(7);
      37              : 
      38           44 :   OptionSet options = UserTensorBase::expected_options();
      39           44 :   options.doc() = "Construct an empty " + tensor_type +
      40              :                   " with given batch shape. Tensor values are **undefined** after construction.";
      41              : 
      42          132 :   options.set<TensorShape>("batch_shape") = {};
      43           44 :   options.set("batch_shape").doc() = "Batch shape";
      44              : 
      45           88 :   return options;
      46           44 : }
      47              : 
      48              : template <typename T>
      49           13 : EmptyPrimitiveTensor<T>::EmptyPrimitiveTensor(const OptionSet & options)
      50           13 :   : T(T::empty(options.get<TensorShape>("batch_shape"), default_tensor_options())),
      51           26 :     UserTensorBase(options)
      52              : {
      53           13 : }
      54              : 
      55              : #define EMPTYPRIMITIVETENSOR_REGISTER(T)                                                           \
      56              :   using Empty##T = EmptyPrimitiveTensor<T>;                                                        \
      57              :   register_NEML2_object_alias(Empty##T, "Empty" #T)
      58              : FOR_ALL_PRIMITIVETENSOR(EMPTYPRIMITIVETENSOR_REGISTER);
      59              : } // namespace neml2