NEML2 2.0.0
Loading...
Searching...
No Matches
CSVPrimitiveTensor< T > Class Template Reference

Create a primitive tensor by reading values from a csv file. More...

Detailed Description

template<typename T>
class neml2::CSVPrimitiveTensor< T >

Create a primitive tensor by reading values from a csv file.

#include <CSVPrimitiveTensor.h>

Inheritance diagram for CSVPrimitiveTensor< T >:

Public Member Functions

 CSVPrimitiveTensor (const OptionSet &options)
 
- Public Member Functions inherited from UserTensorBase< T >
 UserTensorBase (const OptionSet &options)
 
void setup () override
 Setup this object.
 
- Public Member Functions inherited from NEML2Object
 NEML2Object ()=delete
 
 NEML2Object (NEML2Object &&)=delete
 
 NEML2Object (const NEML2Object &)=delete
 
NEML2Objectoperator= (NEML2Object &&)=delete
 
NEML2Objectoperator= (const NEML2Object &)=delete
 
virtual ~NEML2Object ()=default
 
 NEML2Object (const OptionSet &options)
 Construct a new NEML2Object object.
 
const OptionSetinput_options () const
 
const std::string & name () const
 A readonly reference to the object's name.
 
const std::string & type () const
 A readonly reference to the object's type.
 
const std::string & path () const
 A readonly reference to the object's path.
 
const std::string & doc () const
 A readonly reference to the object's docstring.
 
Factoryfactory () const
 Get the factory that created this object.
 
const Settingssettings () const
 Settings.
 
template<typename T = NEML2Object>
const T * host () const
 Get a readonly pointer to the host.
 
template<typename T = NEML2Object>
T * host ()
 Get a writable pointer to the host.
 
template<typename T >
const T & resolve_tensor (const std::string &name)
 Resolve a TensorName to a Tensor.
 
template<class T >
std::shared_ptr< T > get_object (const std::string &section, const std::string &name)
 
template<class T = Solver>
std::shared_ptr< T > get_solver (const std::string &name)
 Get a solver from the factory.
 
template<class T = Data>
std::shared_ptr< T > get_data (const std::string &name)
 Get a data from the factory.
 
template<class T = Model>
std::shared_ptr< T > get_model (const std::string &name)
 Get a model from the factory.
 
template<class T = Driver>
std::shared_ptr< T > get_driver (const std::string &name)
 Get a driver from the factory.
 
template<class T = WorkScheduler>
std::shared_ptr< T > get_scheduler (const std::string &name)
 Get a scheduler from the factory.
 
- Public Member Functions inherited from CSVReader
 CSVReader (const NEML2Object *obj)
 

Static Public Member Functions

static OptionSet expected_options ()
 
- Static Public Member Functions inherited from UserTensorBase< T >
static OptionSet expected_options ()
 
- Static Public Member Functions inherited from NEML2Object
static OptionSet expected_options ()
 
- Static Public Member Functions inherited from CSVReader
static OptionSet expected_options ()
 

Protected Member Functions

make () const override
 Create the tensor given input options.
 
- Protected Member Functions inherited from UserTensorBase< T >
- Protected Member Functions inherited from CSVReader
csv::CSVFormat parse_format () const
 Helper function to parse CSV format.
 
std::vector< unsigned int > parse_indices (const csv::CSVReader &csv) const
 Helper function to parse column indices.
 
void read_all (csv::CSVReader &csv, std::vector< double > &vals, std::size_t &nrow, std::size_t &ncol) const
 Read all values without column indices.
 
void read_by_indices (csv::CSVReader &csv, const std::vector< unsigned int > &indices, std::vector< double > &vals, std::size_t &nrow, std::size_t &ncol) const
 Read values by specified column indices.
 

Additional Inherited Members

- Static Protected Member Functions inherited from UserTensorBase< T >
static std::string tensor_type ()
 A human-readable description of the tensor type.
 

Constructor & Destructor Documentation

◆ CSVPrimitiveTensor()

template<typename T >
CSVPrimitiveTensor ( const OptionSet & options)

Member Function Documentation

◆ expected_options()

template<typename T >
static OptionSet expected_options ( )
static

◆ make()

template<typename T >
T make ( ) const
overrideprotectedvirtual

Create the tensor given input options.

Implements UserTensorBase< T >.