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/linalg/vector_norm.h"
      26              : #include "neml2/tensors/functions/abs.h"
      27              : #include "neml2/tensors/Tensor.h"
      28              : #include "neml2/tensors/Scalar.h"
      29              : #include "neml2/tensors/assertions.h"
      30              : 
      31              : namespace neml2::linalg
      32              : {
      33              : Scalar
      34         1600 : vector_norm(const Tensor & v)
      35              : {
      36         1600 :   neml_assert_dbg(v.base_dim() == 0 || v.base_dim() == 1,
      37              :                   "v in vector_norm has base dimension ",
      38         1600 :                   v.base_dim(),
      39              :                   " instead of 0 or 1.");
      40              : 
      41              :   // If the vector is a scalar just return its absolute value
      42         1600 :   if (v.base_dim() == 0)
      43           69 :     return neml2::abs(v);
      44              : 
      45         4593 :   return Tensor(
      46         3062 :       at::linalg_vector_norm(v, /*order=*/2, /*dim=*/-1, /*keepdim=*/false, /*dtype=*/c10::nullopt),
      47         1531 :       v.batch_sizes());
      48              : }
      49              : } // namespace neml2::linalg