Reference documentation for deal.II version Git ac8d010384 2020-11-27 19:49:05 +0100
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Functions
Differentiation::SD::Utilities Namespace Reference

Functions

SymEngine::map_basic_basic convert_expression_map_to_basic_map (const SD::types::substitution_map &substitution_map)
 
SD::types::substitution_map convert_basic_map_to_expression_map (const SymEngine::map_basic_basic &substitution_map)
 
SymEngine::vec_basic convert_expression_vector_to_basic_vector (const SD::types::symbol_vector &symbol_vector)
 
SD::types::symbol_vector convert_basic_vector_to_expression_vector (const SymEngine::vec_basic &symbol_vector)
 
std::vector< std::pair< Expression, Expression > > convert_basic_pair_vector_to_expression_pair_vector (const SymEngine::vec_pair &symbol_value_vector)
 
SD::types::symbol_vector extract_symbols (const SD::types::substitution_map &substitution_values)
 
template<typename NumberType , typename ExpressionType = SD::Expression>
std::vector< NumberType > extract_values (const SD::types::substitution_map &substitution_values)
 
template<typename StreamType >
StreamType & print_substitution_map (StreamType &stream, const SD::types::substitution_map &symbol_value_map)
 

Function Documentation

◆ convert_expression_map_to_basic_map()

SymEngine::map_basic_basic Differentiation::SD::Utilities::convert_expression_map_to_basic_map ( const SD::types::substitution_map substitution_map)

Convert a map of Expressions to its SymEngine counterpart.

◆ convert_basic_map_to_expression_map()

SD::types::substitution_map Differentiation::SD::Utilities::convert_basic_map_to_expression_map ( const SymEngine::map_basic_basic &  substitution_map)

Convert to a map of Expressions from its SymEngine counterpart.

◆ convert_expression_vector_to_basic_vector()

SymEngine::vec_basic Differentiation::SD::Utilities::convert_expression_vector_to_basic_vector ( const SD::types::symbol_vector symbol_vector)

Convert a vector of Expressions to its SymEngine counterpart.

◆ convert_basic_vector_to_expression_vector()

SD::types::symbol_vector Differentiation::SD::Utilities::convert_basic_vector_to_expression_vector ( const SymEngine::vec_basic &  symbol_vector)

Convert to a vector of Expressions from its SymEngine counterpart.

◆ convert_basic_pair_vector_to_expression_pair_vector()

std::vector<std::pair<Expression, Expression> > Differentiation::SD::Utilities::convert_basic_pair_vector_to_expression_pair_vector ( const SymEngine::vec_pair &  symbol_value_vector)

Convert to a vector of pairs of Expressions from its SymEngine counterpart.

◆ extract_symbols()

SD::types::symbol_vector Differentiation::SD::Utilities::extract_symbols ( const SD::types::substitution_map substitution_values)

Extract the symbols (key entries) from a substitution map.

Note
It is guaranteed that the order of extraction of data into the output vector is the same as that for extract_values(). That is to say that the unzipped key and value pairs as given by extract_symbols() and extract_values() always have a 1:1 correspondence.

◆ extract_values()

template<typename NumberType , typename ExpressionType = SD::Expression>
std::vector<NumberType> Differentiation::SD::Utilities::extract_values ( const SD::types::substitution_map substitution_values)

Extract the values from a substitution map. The value entries will be converted into the NumberType given as a template parameter to this function via the ExpressionType.

Note
It is guaranteed that the order of extraction of data into the output vector is the same as that for extract_symbols(). That is to say that the unzipped key and value pairs as given by extract_symbols() and extract_values() always have a 1:1 correspondence.

◆ print_substitution_map()

template<typename StreamType >
StreamType& Differentiation::SD::Utilities::print_substitution_map ( StreamType &  stream,
const SD::types::substitution_map symbol_value_map 
)

Print the key and value pairs stored in a substitution map.