Firefly 3.1.0
Standalone library for vector calculations
Loading...
Searching...
No Matches
firefly Namespace Reference

Namespaces

namespace  utilities
 

Classes

struct  common_type
 Customised common_type implementation that handles cases where one or both types may be arithmetic or std::complex. More...
 
struct  common_type< std::complex< T1 >, std::complex< T2 > >
 Specialisation of common_type for cases where both types are std::complex. More...
 
struct  common_type< std::complex< T1 >, T2 >
 Specialisation of common_type for cases where the first type is std::complex and the second is arithmetic. More...
 
struct  common_type< T1, std::complex< T2 > >
 Specialisation of common_type for cases where the first type is arithmetic and the second is std::complex. More...
 
struct  is_complex
 Trait to determine if a type is a std::complex type. More...
 
struct  is_complex< std::complex< T > >
 Specialization of is_complex for std::complex types. More...
 
class  vector
 Represents a mathematical vector in n-dimensional space. More...
 

Concepts

concept  complex_type
 Concept that ensures the type is a complex number type.
 
concept  vector_type
 Concept that ensures the type is either arithmetic or a complex type.
 

Typedefs

template<typename T1 , typename T2 >
using common_type_t = typename common_type< T1, T2 >::type
 Helper alias template for the common_type structure, similar to std::common_type_t.
 

Variables

template<typename T >
constexpr bool is_complex_v = is_complex<T>::value
 Helper variable template for is_complex.
 

Typedef Documentation

◆ common_type_t

template<typename T1 , typename T2 >
using firefly::common_type_t = typedef typename common_type<T1, T2>::type

Helper alias template for the common_type structure, similar to std::common_type_t.

Provides an alias for the type resulting from the common_type structure.

Template Parameters
T1First type
T2Second type

Variable Documentation

◆ is_complex_v

template<typename T >
constexpr bool firefly::is_complex_v = is_complex<T>::value
inlineconstexpr

Helper variable template for is_complex.

This variable evaluates to true if T is a std::complex type, otherwise false.

Template Parameters
TThe type to check.