Wrapper data structure around std::array. More...

#include <JArray.hh>

Inheritance diagram for JTOOLS::JArray< N, T >:

Public Types
typedef std::array< T, N >	array_type

typedef JClass< T >::argument_type	argument_type

typedef std::conditional< std::is_const< T >::value, typenamestd::remove_const< T >::type, typenamestd::add_const< T >::type >::type	U

Public Member Functions
	JArray ()
	Default constructor.

template<unsigned int M>
	JArray (const JArray< M, T > &array)
	Copy constructor.

template<unsigned int M>
	JArray (const JArray< M, U > &array)
	Copy constructor.

template<class ... Args>
	JArray (argument_type value, const Args &...args)
	Assemble constructor.

	JArray (const T *p)
	Multi-copy constructor.

template<size_t M>
	JArray (const std::array< T, M > &first, const std::array< T, N-M > &second)
	Combine constructor.

template<size_t M, class ... Args>
	JArray (const std::array< T, M > &array, argument_type value, const Args &...args)
	Copy and assemble constructor.

template<size_t M, class ... Args>
	JArray (const std::array< U, M > &array, argument_type value, const Args &...args)
	Copy and assemble constructor.

	JArray (const JMultiKey< N, T > &key)
	Convert constructor.

	JArray (const JMultiKey< N, U > &key)
	Convert constructor.

template<unsigned int M>
	JArray (const JMultiKey< M, T > &key, const std::array< std::remove_const_t< T >, N-M > &array)
	Convert and combine constructor.

template<unsigned int M>
	JArray (const JMultiKey< M, U > &key, const std::array< std::remove_const_t< T >, N-M > &array)
	Convert and combine constructor.

template<unsigned int M, class ... Args>
	JArray (const JMultiKey< M, T > &key, argument_type value, const Args &...args)
	Convert and assemble constructor.

template<unsigned int M, class ... Args>
	JArray (const JMultiKey< M, U > &key, argument_type value, const Args &...args)
	Convert and assemble constructor.

JArray< N-1, T >	pop_front () const
	Make a copy in which the first element is removed.

JArray< N-1, T >	pop_back () const
	Make a copy in which the last element is removed.

JArray< N+1, T >	push_back (argument_type value) const
	Make a copy and push back value.

JArray &	negate ()
	Negate array.

JArray &	add (const JArray &array)
	Add array.

JArray &	sub (const JArray &array)
	Subtract array.

JArray &	mul (const double factor)
	Scale array.

JArray &	div (const double factor)
	Scale array.

bool	equals (const JArray< N, T > &array) const
	Check equality.

JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.

Protected Member Functions
template<size_t ... i>
JArray< sizeof...(i), T >	pop_back (const std::index_sequence< i... > &ls) const
	Auxiliary method to pop back array.

template<size_t ... i>
JArray< N-1, T >	pop_front (const std::index_sequence< i... > &ls) const
	Auxiliary method to pop front array.

template<size_t ... i>
JArray< N+1, T >	push_back (argument_type value, const std::index_sequence< i... > &ls) const
	Push back array.

Static Protected Member Functions
template<size_t M, size_t ... i>
static std::array< T, N >	match (const std::array< T, M > &array, const std::index_sequence< i... > &ls)
	Auxiliary method to match array.

template<size_t M>
static std::array< T, N >	match (const std::array< T, M > &array)
	Match array.

template<size_t ... i>
static std::array< T, sizeof...(i)>	convert (const std::array< U, sizeof...(i)> &array, const std::index_sequence< i... > &ls)
	Auxiliary method to convert array.

template<size_t M>
static std::array< T, M >	convert (const std::array< U, M > &array)
	Convert array.

template<size_t ... iv, size_t ... iw>
static std::array< T, N >	combine (const std::array< T, sizeof...(iv)> &v, const std::index_sequence< iv... > &lv, const std::array< T, sizeof...(iw)> &w, const std::index_sequence< iw... > &lw)
	Auxiliary method combine arrays.

template<size_t M>
static std::array< T, N >	combine (const std::array< T, M > &first, const std::array< T, N-M > &second)
	Combine two arrays.

template<class ... Args>
static JArray< N-1, T >	pop_front (argument_type value, const Args &...args)
	Auxiliary method to pop front array.

Friends
std::istream &	operator>> (std::istream &in, JArray &array)
	Read array from input stream.

std::ostream &	operator<< (std::ostream &out, const JArray &array)
	Write array to output stream.

JReader &	operator>> (JReader &in, JArray &buffer)
	Read array from input.

JWriter &	operator<< (JWriter &out, const JArray &buffer)
	Write array to output.

Detailed Description

template<unsigned int N, class T>
struct JTOOLS::JArray< N, T >

Wrapper data structure around std::array.

Definition at line 39 of file JArray.hh.

Member Typedef Documentation

◆ array_type

template<unsigned int N, class T >

std::array<T, N> JTOOLS::JArray< N, T >::array_type

Definition at line 46 of file JArray.hh.

◆ argument_type

template<unsigned int N, class T >

JClass<T>::argument_type JTOOLS::JArray< N, T >::argument_type

Definition at line 60 of file JArray.hh.

◆ U

template<unsigned int N, class T >

std::conditional<std::is_const<T>::value,typenamestd::remove_const<T>::type,typenamestd::add_const<T>::type>::type JTOOLS::JArray< N, T >::U

Definition at line 64 of file JArray.hh.

Constructor & Destructor Documentation

◆ JArray() [1/14]

template<unsigned int N, class T >

JTOOLS::JArray< N, T >::JArray ( )

inline

Default constructor.

Definition at line 70 of file JArray.hh.

             :
      std::array<T, N>()
    {}

◆ JArray() [2/14]

template<unsigned int N, class T >

template<unsigned int M>

JTOOLS::JArray< N, T >::JArray ( const JArray< M, T > & array )

inline

Copy constructor.

Parameters

array array

Definition at line 81 of file JArray.hh.

                                      :
      std::array<T, N>(match(array))
    {}

◆ JArray() [3/14]

template<unsigned int N, class T >

template<unsigned int M>

JTOOLS::JArray< N, T >::JArray ( const JArray< M, U > & array )

inline

Copy constructor.

Parameters

array array

Definition at line 92 of file JArray.hh.

                                      :
      std::array<T, N>(match(convert(array)))
    {}

◆ JArray() [4/14]

template<unsigned int N, class T >

template<class ... Args>

JTOOLS::JArray< N, T >::JArray	(	argument_type	value,
		const Args &...	args )

inline

Assemble constructor.

Parameters

value	value
args	argument list

Definition at line 104 of file JArray.hh.

                                                     :
      std::array<T, N>({value, args...})
    {}

◆ JArray() [5/14]

template<unsigned int N, class T >

JTOOLS::JArray< N, T >::JArray ( const T * p )

inline

Multi-copy constructor.

Parameters

p	pointer to data

Definition at line 114 of file JArray.hh.

    {
      std::copy_n(p, N, this->data());
    }

◆ JArray() [6/14]

template<unsigned int N, class T >

template<size_t M>

JTOOLS::JArray< N, T >::JArray	(	const std::array< T, M > &	first,
		const std::array< T, N-M > &	second )

inline

Combine constructor.

Parameters

first	first array
second	second array

Definition at line 127 of file JArray.hh.

                                                                        :
      std::array<T, N>(combine(first, second))
    {}

◆ JArray() [7/14]

template<unsigned int N, class T >

template<size_t M, class ... Args>

JTOOLS::JArray< N, T >::JArray	(	const std::array< T, M > &	array,
		argument_type	value,
		const Args &...	args )

inline

Copy and assemble constructor.

Parameters

array	array
value	value
args	argument list

Definition at line 140 of file JArray.hh.

                                                                                  :
      JArray(array, std::array<T, N-M>({value, args...}))
    {}

◆ JArray() [8/14]

template<unsigned int N, class T >

template<size_t M, class ... Args>

JTOOLS::JArray< N, T >::JArray	(	const std::array< U, M > &	array,
		argument_type	value,
		const Args &...	args )

inline

Copy and assemble constructor.

Parameters

array	array
value	value
args	argument list

Definition at line 153 of file JArray.hh.

                                                                                  :
      JArray(convert(array), std::array<T, N-M>({value, args...}))
    {}

◆ JArray() [9/14]

template<unsigned int N, class T >

JTOOLS::JArray< N, T >::JArray ( const JMultiKey< N, T > & key )

inline

Convert constructor.

Parameters

key key

Definition at line 163 of file JArray.hh.

                                       :
      std::array<T, N>(key)
    {}

◆ JArray() [10/14]

template<unsigned int N, class T >

JTOOLS::JArray< N, T >::JArray ( const JMultiKey< N, U > & key )

inline

Convert constructor.

Parameters

key key

Definition at line 173 of file JArray.hh.

                                       :
      std::array<T, N>(convert((std::array<U, N>) key))
    {}

◆ JArray() [11/14]

template<unsigned int N, class T >

template<unsigned int M>

JTOOLS::JArray< N, T >::JArray	(	const JMultiKey< M, T > &	key,
		const std::array< std::remove_const_t< T >, N-M > &	array )

inline

Convert and combine constructor.

Parameters

key	key
array	array

Definition at line 185 of file JArray.hh.

                                                                                         :
      JArray((std::array<T, M>) key, array)
    {}

◆ JArray() [12/14]

template<unsigned int N, class T >

template<unsigned int M>

JTOOLS::JArray< N, T >::JArray	(	const JMultiKey< M, U > &	key,
		const std::array< std::remove_const_t< T >, N-M > &	array )

inline

Convert and combine constructor.

Parameters

key	key
array	array

Definition at line 197 of file JArray.hh.

                                                                                         :
      JArray(convert((std::array<U, M>) key), array)
    {}

◆ JArray() [13/14]

template<unsigned int N, class T >

template<unsigned int M, class ... Args>

JTOOLS::JArray< N, T >::JArray	(	const JMultiKey< M, T > &	key,
		argument_type	value,
		const Args &...	args )

inline

Convert and assemble constructor.

Parameters

key	key
value	value
args	argument list

Definition at line 210 of file JArray.hh.

                                                                                 :
      JArray(key, std::array<T, N-M>({value, args...}))
    {}

◆ JArray() [14/14]

template<unsigned int N, class T >

template<unsigned int M, class ... Args>

JTOOLS::JArray< N, T >::JArray	(	const JMultiKey< M, U > &	key,
		argument_type	value,
		const Args &...	args )

inline

Convert and assemble constructor.

Parameters

key	key
value	value
args	argument list

Definition at line 223 of file JArray.hh.

                                                                                 :
      JArray(key, std::array<T, N-M>({value, args...}))
    {}

Member Function Documentation

◆ pop_front() [1/3]

template<unsigned int N, class T >

JArray< N-1, T > JTOOLS::JArray< N, T >::pop_front ( ) const

inline

Make a copy in which the first element is removed.

Returns: array

Definition at line 233 of file JArray.hh.

    {
      return pop_front(std::make_index_sequence<N>{});
    }

◆ pop_back() [1/2]

template<unsigned int N, class T >

JArray< N-1, T > JTOOLS::JArray< N, T >::pop_back ( ) const

inline

Make a copy in which the last element is removed.

Returns: array

Definition at line 244 of file JArray.hh.

    {
      return pop_back(std::make_index_sequence<N-1>{});
    }

◆ push_back() [1/2]

template<unsigned int N, class T >

JArray< N+1, T > JTOOLS::JArray< N, T >::push_back ( argument_type value ) const

inline

Make a copy and push back value.

Parameters

value value

Returns: array

Definition at line 256 of file JArray.hh.

    {
      return push_back(value, std::make_index_sequence<N>{});
    }

◆ negate()

template<unsigned int N, class T >

JArray & JTOOLS::JArray< N, T >::negate ( )

inline

Negate array.

Returns: this array

Definition at line 267 of file JArray.hh.

    {
      for (int i = 0; i != N; ++i) {
        (*this)[i] = -(*this)[i];
      }
 
      return *this;
    }

◆ add()

template<unsigned int N, class T >

JArray & JTOOLS::JArray< N, T >::add ( const JArray< N, T > & array )

inline

Add array.

Parameters

array array

Returns: this array

Definition at line 283 of file JArray.hh.

    {
      for (int i = 0; i != N; ++i) {
        (*this)[i] += array[i];
      }
 
      return *this;
    }

◆ sub()

template<unsigned int N, class T >

JArray & JTOOLS::JArray< N, T >::sub ( const JArray< N, T > & array )

inline

Subtract array.

Parameters

array array

Returns: this array

Definition at line 299 of file JArray.hh.

    {
      for (int i = 0; i != N; ++i) {
        (*this)[i] -= array[i];
      }
 
      return *this;
    }

◆ mul() [1/2]

template<unsigned int N, class T >

JArray & JTOOLS::JArray< N, T >::mul ( const double factor )

inline

Scale array.

Parameters

factor multiplication factor

Returns: this array

Definition at line 315 of file JArray.hh.

    {
      for (int i = 0; i != N; ++i) {
        (*this)[i] *= factor;
      }
 
      return *this;
    }

◆ div()

template<unsigned int N, class T >

JArray & JTOOLS::JArray< N, T >::div ( const double factor )

inline

Scale array.

Parameters

factor division factor

Returns: this array

Definition at line 331 of file JArray.hh.

    {
      for (int i = 0; i != N; ++i) {
        (*this)[i] /= factor;
      }
 
      return *this;
    }

◆ equals()

template<unsigned int N, class T >

bool JTOOLS::JArray< N, T >::equals ( const JArray< N, T > & array ) const

inline

Check equality.

Parameters

array array

Returns: true if arrays are equal; else false

Definition at line 347 of file JArray.hh.

    {
      for (int i = 0; i != N; ++i) {
        if ((*this)[i] != array[i]) {
          return false;
        }
      }
 
      return true;
    }

◆ match() [1/2]

template<unsigned int N, class T >

template<size_t M, size_t ... i>

static std::array< T, N > JTOOLS::JArray< N, T >::match	(	const std::array< T, M > &	array,
		const std::index_sequence< i... > &	ls )

inlinestaticprotected

Auxiliary method to match array.

Parameters

array	array
ls	indices of array

Returns: array

Definition at line 437 of file JArray.hh.

    {
      return {array[i]...};
    };

◆ match() [2/2]

template<unsigned int N, class T >

template<size_t M>

static std::array< T, N > JTOOLS::JArray< N, T >::match ( const std::array< T, M > & array )

inlinestaticprotected

Match array.

Parameters

array array

Returns: array

Definition at line 450 of file JArray.hh.

    {
      return match(array, std::make_index_sequence<N>{});
    };

◆ convert() [1/2]

template<unsigned int N, class T >

template<size_t ... i>

static std::array< T, sizeof...(i)> JTOOLS::JArray< N, T >::convert	(	const std::array< U, sizeof...(i)> &	array,
		const std::index_sequence< i... > &	ls )

inlinestaticprotected

Auxiliary method to convert array.

Parameters

array	array
ls	indices of array

Returns: array

Definition at line 464 of file JArray.hh.

    {
      return {array[i]...};
    };

◆ convert() [2/2]

template<unsigned int N, class T >

template<size_t M>

static std::array< T, M > JTOOLS::JArray< N, T >::convert ( const std::array< U, M > & array )

inlinestaticprotected

Convert array.

Parameters

array array

Returns: array

Definition at line 477 of file JArray.hh.

    {
      return convert(array, std::make_index_sequence<M>{});
    };

◆ combine() [1/2]

template<unsigned int N, class T >

template<size_t ... iv, size_t ... iw>

static std::array< T, N > JTOOLS::JArray< N, T >::combine	(	const std::array< T, sizeof...(iv)> &	v,
		const std::index_sequence< iv... > &	lv,
		const std::array< T, sizeof...(iw)> &	w,
		const std::index_sequence< iw... > &	lw )

inlinestaticprotected

Auxiliary method combine arrays.

Parameters

v	first array
lv	indices of first array
w	second array
lw	indices of second array

Definition at line 492 of file JArray.hh.

    {
      return { v[iv]..., w[iw]... };
    };

◆ combine() [2/2]

template<unsigned int N, class T >

template<size_t M>

static std::array< T, N > JTOOLS::JArray< N, T >::combine	(	const std::array< T, M > &	first,
		const std::array< T, N-M > &	second )

inlinestaticprotected

Combine two arrays.

Parameters

first	first array
second	second array

Returns: array

Definition at line 507 of file JArray.hh.

    {
      return combine(first,  std::make_index_sequence< M >{},
                     second, std::make_index_sequence<N-M>{});
    }

◆ pop_back() [2/2]

template<unsigned int N, class T >

template<size_t ... i>

JArray< sizeof...(i), T > JTOOLS::JArray< N, T >::pop_back ( const std::index_sequence< i... > & ls ) const

inlineprotected

Auxiliary method to pop back array.

Parameters

ls	indices of array

Returns: array

Definition at line 521 of file JArray.hh.

    {
      return {(*this)[i]...};
    };

◆ pop_front() [2/3]

template<unsigned int N, class T >

template<class ... Args>

static JArray< N-1, T > JTOOLS::JArray< N, T >::pop_front	(	argument_type	value,
		const Args &...	args )

inlinestaticprotected

Auxiliary method to pop front array.

Parameters

value	value
args	argument list

Returns: array

Definition at line 535 of file JArray.hh.

    {
      return {args...};
    };

◆ pop_front() [3/3]

template<unsigned int N, class T >

template<size_t ... i>

JArray< N-1, T > JTOOLS::JArray< N, T >::pop_front ( const std::index_sequence< i... > & ls ) const

inlineprotected

Auxiliary method to pop front array.

Parameters

ls	indices of array

Returns: array

Definition at line 548 of file JArray.hh.

    {
      return pop_front((*this)[i]...);
    };

◆ push_back() [2/2]

template<unsigned int N, class T >

template<size_t ... i>

JArray< N+1, T > JTOOLS::JArray< N, T >::push_back	(	argument_type	value,
		const std::index_sequence< i... > &	ls ) const

inlineprotected

Push back array.

Parameters

value	value
ls	indices of array

Returns: array

Definition at line 562 of file JArray.hh.

    {
      return {value, (*this)[i]...};
    };

◆ mul() [2/2]

template<class JFirst_t , class JSecond_t >

JFirst_t & JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 354 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
    }

Friends And Related Symbol Documentation

◆ operator>> [1/2]

template<unsigned int N, class T >

std::istream & operator>>	(	std::istream &	in,
		JArray< N, T > &	array )

friend

Read array from input stream.

Parameters

in	input stream
array	array

Returns: input stream

Definition at line 366 of file JArray.hh.

    {
      for (iterator i = array.begin(); i != array.end(); ++i) {
        in >> *i;
      }
 
      return in;
    }

◆ operator<< [1/2]

template<unsigned int N, class T >

std::ostream & operator<<	(	std::ostream &	out,
		const JArray< N, T > &	array )

friend

Write array to output stream.

Parameters

out	output stream
array	array

Returns: output stream

Definition at line 383 of file JArray.hh.

    {
      const JFormat format(out, getFormat<JArray>(JFormat_t(10, 3, std::ios::fixed | std::ios::showpos)));
 
      for (const_iterator i = array.begin(); i != array.end(); ++i) {
        out << ' ' << format << *i;
      }
 
      return out;
    }

◆ operator>> [2/2]

template<unsigned int N, class T >

JReader & operator>>	(	JReader &	in,
		JArray< N, T > &	buffer )

friend

Read array from input.

Parameters

in	reader
buffer	array

Returns: reader

Definition at line 402 of file JArray.hh.

    {
      for (iterator i = buffer.begin(); i != buffer.end(); ++i) {
        in >> *i;
      }
 
      return in;
    }

◆ operator<< [2/2]

template<unsigned int N, class T >

JWriter & operator<<	(	JWriter &	out,
		const JArray< N, T > &	buffer )

friend

Write array to output.

Parameters

out	writer
buffer	array

Returns: writer

Definition at line 419 of file JArray.hh.

    {
      for (const_iterator i = buffer.begin(); i != buffer.end(); ++i) {
        out << *i;
      }
 
      return out;
    }

The documentation for this struct was generated from the following file:

JArray.hh

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ array_type

◆ argument_type

◆ U

Constructor & Destructor Documentation

◆ JArray() [1/14]

◆ JArray() [2/14]

◆ JArray() [3/14]

◆ JArray() [4/14]

◆ JArray() [5/14]

◆ JArray() [6/14]

◆ JArray() [7/14]

◆ JArray() [8/14]

◆ JArray() [9/14]

◆ JArray() [10/14]

◆ JArray() [11/14]

◆ JArray() [12/14]

◆ JArray() [13/14]

◆ JArray() [14/14]

Member Function Documentation

◆ pop_front() [1/3]

◆ pop_back() [1/2]

◆ push_back() [1/2]

◆ negate()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ div()

◆ equals()

◆ match() [1/2]

◆ match() [2/2]

◆ convert() [1/2]

◆ convert() [2/2]

◆ combine() [1/2]

◆ combine() [2/2]

◆ pop_back() [2/2]

◆ pop_front() [2/3]

◆ pop_front() [3/3]

◆ push_back() [2/2]

◆ mul() [2/2]

Friends And Related Symbol Documentation

◆ operator>> [1/2]

◆ operator<< [1/2]

◆ operator>> [2/2]

◆ operator<< [2/2]