TDMS
Time Domain Maxwell Solver
Loading...
Searching...
No Matches
MatrixCollection Class Reference

#include <matrix_collection.h>

Inheritance diagram for MatrixCollection:
[legend]

Public Member Functions

 MatrixCollection ()=default
 Construct a new Matrix Collection object.
 MatrixCollection (std::vector< std::string > names)
 Construct a new Matrix Collection object.
void check_has_at_least_as_many_matrices_as (MatrixCollection &other)
 Check we have as many or more matrices than another MatrixCollection.

Public Attributes

int n_matrices = 0
std::vector< std::string > matrix_names

Detailed Description

A collection of matlab matrices with names

Constructor & Destructor Documentation

◆ MatrixCollection()

MatrixCollection::MatrixCollection ( std::vector< std::string > names)
explicit

Construct a new Matrix Collection object.

Parameters
namesof the matrices
numberof matrices in the collection

Member Function Documentation

◆ check_has_at_least_as_many_matrices_as()

void MatrixCollection::check_has_at_least_as_many_matrices_as ( MatrixCollection & other)

Check we have as many or more matrices than another MatrixCollection.

Throws a runtime error if there are fewer matrices in the other MatrixCollection

Parameters
otherthe other MatrixCollection

The documentation for this class was generated from the following files: