NEML2 2.0.0
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
TensorLoader.h
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#pragma once
26
27#include "neml2/dispatchers/SliceGenerator.h"
28#include "neml2/tensors/Tensor.h"
29
30namespace neml2
31{
33{
34public:
35 TensorLoader(const Tensor & tensor, Size batch_dim);
36
37 std::size_t total() const override;
38
39protected:
40 std::pair<std::size_t, Tensor> generate(std::size_t n) override;
41
42private:
44 const Tensor _tensor;
45
47 const Size _batch_dim;
48
50 SliceGenerator _slice_gen;
51};
52} // namespace neml2
Interface for work generators that generate a fixed number of batches, i.e., the total amount of work...
Definition FixedSizeWorkGenerator.h:38
Definition SliceGenerator.h:34
std::pair< std::size_t, Tensor > generate(std::size_t n) override
Generate the next n batches of work.
Definition TensorLoader.cxx:43
std::size_t total() const override
Total (fixed) number of batches that will be generated.
Definition TensorLoader.cxx:37
TensorLoader(const Tensor &tensor, Size batch_dim)
Definition TensorLoader.cxx:29
Definition Tensor.h:46
Definition DiagnosticsInterface.cxx:30
int64_t Size
Definition types.h:69