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/tensors/functions/mean.h"
      26              : #include "neml2/tensors/tensors.h"
      27              : #include "neml2/tensors/assertions.h"
      28              : 
      29              : namespace neml2
      30              : {
      31              : #define DEFINE_BATCH_MEAN(T)                                                                       \
      32              :   T batch_mean(const T & a, Size d)                                                                \
      33              :   {                                                                                                \
      34              :     neml_assert_dbg(a.batched(), "Must have a batch dimension to take average");                   \
      35              :     auto d2 = d >= 0 ? d : d - a.base_dim();                                                       \
      36              :     return T(at::mean(a, d2), a.batch_dim() - 1);                                                  \
      37              :   }                                                                                                \
      38              :   static_assert(true)
      39            1 : FOR_ALL_TENSORBASE(DEFINE_BATCH_MEAN);
      40              : 
      41              : Tensor
      42            0 : base_mean(const Tensor & a, Size d)
      43              : {
      44            0 :   auto d2 = d < 0 ? d : d + a.batch_dim();
      45            0 :   return Tensor(at::mean(a, d2), a.batch_sizes());
      46              : }
      47              : } // namespace neml2