LBANN  0.103.0
LivermoreBigArtificialNeuralNetworkToolkit
describable.hpp
Go to the documentation of this file.
1 // Copyright (c) 2014-2023, Lawrence Livermore National Security, LLC.
3 // Produced at the Lawrence Livermore National Laboratory.
4 // Written by the LBANN Research Team (B. Van Essen, et al.) listed in
5 // the CONTRIBUTORS file. <lbann-dev@llnl.gov>
6 //
7 // LLNL-CODE-697807.
8 // All rights reserved.
9 //
10 // This file is part of LBANN: Livermore Big Artificial Neural Network
11 // Toolkit. For details, see http://software.llnl.gov/LBANN or
12 // https://github.com/LLNL/LBANN.
13 //
14 // Licensed under the Apache License, Version 2.0 (the "Licensee"); you
15 // may not use this file except in compliance with the License. You may
16 // obtain a copy of the License at:
17 //
18 // http://www.apache.org/licenses/LICENSE-2.0
19 //
20 // Unless required by applicable law or agreed to in writing, software
21 // distributed under the License is distributed on an "AS IS" BASIS,
22 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
23 // implied. See the License for the specific language governing
24 // permissions and limitations under the license.
26 #ifndef LBANN_UTILS_DESCRIBABLE_HPP_INCLUDED
27 #define LBANN_UTILS_DESCRIBABLE_HPP_INCLUDED
28 
30 
31 namespace lbann {
32 
35 
38 {
39 public:
40  virtual ~Describable() = default;
42  virtual Description get_description() const = 0;
43 }; // class Describable
44 
45 inline std::ostream& operator<<(std::ostream& os, Describable const& obj)
46 {
47  return os << obj.get_description();
48 }
49 
50 } // namespace lbann
51 #endif // LBANN_UTILS_DESCRIBABLE_HPP_INCLUDED
virtual Description get_description() const =0
Generate a human-readable description.
Generates nicely formatted description messages.
Definition: description.hpp:49
virtual ~Describable()=default
std::ostream & operator<<(std::ostream &os, const ParallelStrategy &ps)
Definition: layer.hpp:191
A class that can generate self-descriptions.
Definition: describable.hpp:37