is_vector.hpp File Reference

#include <stan/math/prim/meta/bool_constant.hpp>
#include <stan/math/prim/meta/is_eigen.hpp>
#include <stan/math/prim/meta/is_var.hpp>
#include <stan/math/prim/meta/scalar_type.hpp>
#include <stan/math/prim/meta/value_type.hpp>
#include <stan/math/prim/meta/require_helpers.hpp>
#include <type_traits>
#include <vector>

Go to the source code of this file.

Classes
struct	stan::is_std_vector< T, typename >
	Base implementation for checking if type is std vector. More...
struct	stan::internal::is_eigen_col_vector_impl< T, bool >
	Underlying implementation for detecting if an Eigen Matrix is a column vector. More...
struct	stan::internal::is_eigen_col_vector_impl< T, false >
	Specialization for when type is not an eigen vector. More...
struct	stan::internal::is_eigen_row_vector_impl< T, bool >
	Underlying implementation for detecting if an Eigen Matrix is a row vector. More...
struct	stan::internal::is_eigen_row_vector_impl< T, false >
	Specialization for when type is not an eigen vector. More...
struct	stan::internal::is_col_vector_impl< T, bool >
	Underlying implementation for detecting if a Matrix is a column vector. More...
struct	stan::internal::is_col_vector_impl< T, false >
	Specialization for when type is not a vector. More...
struct	stan::internal::is_row_vector_impl< T, bool >
	Underlying implementation for detecting if a Matrix is a row vector. More...
struct	stan::internal::is_row_vector_impl< T, false >
	Specialization for when type is not an vector. More...
struct	stan::is_eigen_col_vector< T >
	If the input type T is an eigen matrix with 1 row at compile time this has a static member with a value of true. More...
struct	stan::is_col_vector< T >
	If the input type T has a static comple time constant type ColsAtCompileTime equal to 1 this has a static member with a value of true. More...
struct	stan::is_eigen_row_vector< T >
	If the input type T is an eigen matrix with 1 column at compile time this has a static member with a value of true. More...
struct	stan::is_row_vector< T >
	If the input type T has a static comple time constant type RowsAtCompileTime equal to 1 this has a static member with a value of true. More...
struct	stan::is_eigen_vector< T >
	If the input type T is an eigen matrix with 1 column or 1 row at compile time this has a static member with a value of true. More...
struct	stan::is_vector< T >
	If the input type T is either an eigen matrix with 1 column or 1 row at compile time or a standard vector, this has a static member with a value of true. More...
struct	stan::internal::is_std_vector_impl< T >
	This underlying implementation is used when the type is not an std vector. More...
struct	stan::internal::is_std_vector_impl< std::vector< Args... > >
	This specialization implementation has a static member named value when the template type is an std vector. More...
struct	stan::is_std_vector< T, std::enable_if_t< internal::is_std_vector_impl< std::decay_t< T > >::value > >
	Checks if the decayed type of T is a standard vector. More...
struct	stan::scalar_type< T, std::enable_if_t< is_std_vector< T >::value > >
	Specialization of scalar_type for vector to recursively return the inner scalar type. More...
struct	stan::value_type< T, std::enable_if_t< is_std_vector< T >::value > >
	Template metaprogram class to compute the type of values stored in a standard vector. More...

Namespaces
namespace	stan
	The lgamma implementation in stan-math is based on either the reentrant safe lgamma_r implementation from C or the boost::math::lgamma implementation.
namespace	stan::internal

Typedefs
template<typename T >
using	stan::require_eigen_col_vector_t = require_t< is_eigen_col_vector< std::decay_t< T > > >
	Require type satisfies is_eigen_col_vector.
template<typename T >
using	stan::require_not_eigen_col_vector_t = require_not_t< is_eigen_col_vector< std::decay_t< T > > >
	Require type does not satisfy is_eigen_col_vector.
template<typename... Types>
using	stan::require_all_eigen_col_vector_t = require_all_t< is_eigen_col_vector< std::decay_t< Types > >... >
	Require all of the types satisfy is_eigen_col_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_eigen_col_vector_vt = require_t< container_type_check_base< is_eigen_col_vector, value_type_t, TypeCheck, Check... > >
	Require type satisfies is_eigen_col_vector.
template<typename T >
using	stan::require_col_vector_t = require_t< is_col_vector< std::decay_t< T > > >
	Require type satisfies is_col_vector.
template<typename T >
using	stan::require_not_col_vector_t = require_not_t< is_col_vector< std::decay_t< T > > >
	Require type does not satisfy is_col_vector.
template<typename... Types>
using	stan::require_all_col_vector_t = require_all_t< is_col_vector< std::decay_t< Types > >... >
	Require all of the types satisfy is_col_vector.
template<typename T >
using	stan::require_eigen_row_vector_t = require_t< is_eigen_row_vector< std::decay_t< T > > >
	Require type satisfies is_eigen_row_vector.
template<typename T >
using	stan::require_row_vector_t = require_t< is_row_vector< std::decay_t< T > > >
	Require type satisfies is_row_vector.
template<typename T >
using	stan::require_eigen_vector_t = require_t< is_eigen_vector< std::decay_t< T > > >
	Require type satisfies is_eigen_vector.
template<typename T >
using	stan::require_not_eigen_vector_t = require_not_t< is_eigen_vector< std::decay_t< T > > >
	Require type does not satisfy is_eigen_vector.
template<typename... Types>
using	stan::require_all_eigen_vector_t = require_all_t< is_eigen_vector< std::decay_t< Types > >... >
	Require all of the types satisfy is_eigen_vector.
template<typename... Types>
using	stan::require_any_eigen_vector_t = require_any_t< is_eigen_vector< std::decay_t< Types > >... >
	Require any of the types satisfy is_eigen_vector.
template<typename... Types>
using	stan::require_all_not_eigen_vector_t = require_all_not_t< is_eigen_vector< std::decay_t< Types > >... >
	Require none of the types satisfy is_eigen_vector.
template<typename... Types>
using	stan::require_any_not_eigen_vector_t = require_any_not_t< is_eigen_vector< std::decay_t< Types > >... >
	Require at least one of the types do not satisfy is_eigen_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_eigen_vector_vt = require_t< container_type_check_base< is_eigen_vector, value_type_t, TypeCheck, Check... > >
	Require type satisfies is_eigen_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_not_eigen_vector_vt = require_not_t< container_type_check_base< is_eigen_vector, value_type_t, TypeCheck, Check... > >
	Require type does not satisfy is_eigen_vector or.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_any_eigen_vector_vt = require_any_t< container_type_check_base< is_eigen_vector, value_type_t, TypeCheck, Check >... >
	Require any of the types satisfy is_eigen_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_any_not_eigen_vector_vt = require_any_not_t< container_type_check_base< is_eigen_vector, value_type_t, TypeCheck, Check >... >
	Require at least one of the types does not satisfy is_eigen_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_all_eigen_vector_vt = require_all_t< container_type_check_base< is_eigen_vector, value_type_t, TypeCheck, Check >... >
	Require all of the types satisfy is_eigen_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_all_not_eigen_vector_vt = require_all_not_t< container_type_check_base< is_eigen_vector, value_type_t, TypeCheck, Check >... >
	Require none of the types satisfy is_eigen_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_eigen_vector_st = require_t< container_type_check_base< is_eigen_vector, scalar_type_t, TypeCheck, Check... > >
	Require type satisfies is_eigen_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_not_eigen_vector_st = require_not_t< container_type_check_base< is_eigen_vector, scalar_type_t, TypeCheck, Check... > >
	Require type does not satisfy is_eigen_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_any_eigen_vector_st = require_any_t< container_type_check_base< is_eigen_vector, scalar_type_t, TypeCheck, Check >... >
	Require any of the types satisfy is_eigen_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_any_not_eigen_vector_st = require_any_not_t< container_type_check_base< is_eigen_vector, scalar_type_t, TypeCheck, Check >... >
	Require at least one of the types does not satisfy is_eigen_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_all_eigen_vector_st = require_all_t< container_type_check_base< is_eigen_vector, scalar_type_t, TypeCheck, Check >... >
	Require all of the types does not satisfy is_eigen_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_all_not_eigen_vector_st = require_all_not_t< container_type_check_base< is_eigen_vector, scalar_type_t, TypeCheck, Check >... >
	Require none of the types satisfy is_eigen_vector.
template<typename Row , typename Col >
using	stan::require_eigen_row_and_col_t = require_t< math::conjunction< is_eigen_row_vector< Row >, is_eigen_col_vector< Col > > >
	Require Row is a row vector and Col is a column vector.
template<typename Row , typename Col >
using	stan::require_not_eigen_row_and_col_t = require_not_t< math::conjunction< is_eigen_row_vector< Row >, is_eigen_col_vector< Col > > >
	Require Row is not a row vector and Col is not a column vector.
template<typename Row , typename Col >
using	stan::require_row_and_col_vector_t = require_t< math::conjunction< is_row_vector< Row >, is_col_vector< Col > > >
	Require Row is a row vector and Col is a column vector.
template<typename Row , typename Col >
using	stan::require_not_row_and_col_vector_t = require_not_t< math::conjunction< is_row_vector< Row >, is_col_vector< Col > > >
	Require Row is not a row vector and Col is not a column vector.
template<typename T >
using	stan::require_vector_t = require_t< is_vector< std::decay_t< T > > >
	Require type satisfies is_vector.
template<typename T >
using	stan::require_not_vector_t = require_not_t< is_vector< std::decay_t< T > > >
	Require type does not satisfy is_vector.
template<typename... Types>
using	stan::require_all_vector_t = require_all_t< is_vector< std::decay_t< Types > >... >
	Require all of the types satisfy is_vector.
template<typename... Types>
using	stan::require_any_vector_t = require_any_t< is_vector< std::decay_t< Types > >... >
	Require any of the types satisfy is_vector.
template<typename... Types>
using	stan::require_all_not_vector_t = require_all_not_t< is_vector< std::decay_t< Types > >... >
	Require none of the types satisfy is_vector.
template<typename... Types>
using	stan::require_any_not_vector_t = require_any_not_t< is_vector< std::decay_t< Types > >... >
	Require at least one of the types do not satisfy is_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_vector_vt = require_t< container_type_check_base< is_vector, value_type_t, TypeCheck, Check... > >
	Require type satisfies is_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_not_vector_vt = require_not_t< container_type_check_base< is_vector, value_type_t, TypeCheck, Check... > >
	Require type does not satisfy is_vector or.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_any_vector_vt = require_any_t< container_type_check_base< is_vector, value_type_t, TypeCheck, Check >... >
	Require any of the types satisfy is_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_any_not_vector_vt = require_any_not_t< container_type_check_base< is_vector, value_type_t, TypeCheck, Check >... >
	Require at least one of the types does not satisfy is_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_all_vector_vt = require_all_t< container_type_check_base< is_vector, value_type_t, TypeCheck, Check >... >
	Require all of the types satisfy is_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_all_not_vector_vt = require_all_not_t< container_type_check_base< is_vector, value_type_t, TypeCheck, Check >... >
	Require none of the types satisfy is_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_vector_st = require_t< container_type_check_base< is_vector, scalar_type_t, TypeCheck, Check... > >
	Require type satisfies is_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_not_vector_st = require_not_t< container_type_check_base< is_vector, scalar_type_t, TypeCheck, Check... > >
	Require type does not satisfy is_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_any_vector_st = require_any_t< container_type_check_base< is_vector, scalar_type_t, TypeCheck, Check >... >
	Require any of the types satisfy is_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_any_not_vector_st = require_any_not_t< container_type_check_base< is_vector, scalar_type_t, TypeCheck, Check >... >
	Require at least one of the types does not satisfy is_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_all_vector_st = require_all_t< container_type_check_base< is_vector, scalar_type_t, TypeCheck, Check >... >
	Require all of the types does not satisfy is_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_all_not_vector_st = require_all_not_t< container_type_check_base< is_vector, scalar_type_t, TypeCheck, Check >... >
	Require none of the types satisfy is_vector.
template<typename T >
using	stan::require_std_vector_t = require_t< is_std_vector< std::decay_t< T > > >
	Require type satisfies is_std_vector.
template<typename T >
using	stan::require_not_std_vector_t = require_not_t< is_std_vector< std::decay_t< T > > >
	Require type does not satisfy is_std_vector.
template<typename... Types>
using	stan::require_all_std_vector_t = require_all_t< is_std_vector< std::decay_t< Types > >... >
	Require all of the types satisfy is_std_vector.
template<typename... Types>
using	stan::require_any_std_vector_t = require_any_t< is_std_vector< std::decay_t< Types > >... >
	Require any of the types satisfy is_std_vector.
template<typename... Types>
using	stan::require_all_not_std_vector_t = require_all_not_t< is_std_vector< std::decay_t< Types > >... >
	Require none of the types satisfy is_std_vector.
template<typename... Types>
using	stan::require_any_not_std_vector_t = require_any_not_t< is_std_vector< std::decay_t< Types > >... >
	Require at least one of the types do not satisfy is_std_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_std_vector_vt = require_t< container_type_check_base< is_std_vector, value_type_t, TypeCheck, Check... > >
	Require type satisfies is_std_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_not_std_vector_vt = require_not_t< container_type_check_base< is_std_vector, value_type_t, TypeCheck, Check... > >
	Require type does not satisfy is_std_vector or.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_any_std_vector_vt = require_any_t< container_type_check_base< is_std_vector, value_type_t, TypeCheck, Check >... >
	Require any of the types satisfy is_std_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_any_not_std_vector_vt = require_any_not_t< container_type_check_base< is_std_vector, value_type_t, TypeCheck, Check >... >
	Require at least one of the types does not satisfy is_std_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_all_std_vector_vt = require_all_t< container_type_check_base< is_std_vector, value_type_t, TypeCheck, Check >... >
	Require all of the types satisfy is_std_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_all_not_std_vector_vt = require_all_not_t< container_type_check_base< is_std_vector, value_type_t, TypeCheck, Check >... >
	Require none of the types satisfy is_std_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_std_vector_st = require_t< container_type_check_base< is_std_vector, scalar_type_t, TypeCheck, Check... > >
	Require type satisfies is_std_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_not_std_vector_st = require_not_t< container_type_check_base< is_std_vector, scalar_type_t, TypeCheck, Check... > >
	Require type does not satisfy is_std_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_any_std_vector_st = require_any_t< container_type_check_base< is_std_vector, scalar_type_t, TypeCheck, Check >... >
	Require any of the types satisfy is_std_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_any_not_std_vector_st = require_any_not_t< container_type_check_base< is_std_vector, scalar_type_t, TypeCheck, Check >... >
	Require at least one of the types does not satisfy is_std_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_all_std_vector_st = require_all_t< container_type_check_base< is_std_vector, scalar_type_t, TypeCheck, Check >... >
	Require all of the types does not satisfy is_std_vector.
template<template< class... > class TypeCheck, class... Check>
using	stan::require_all_not_std_vector_st = require_all_not_t< container_type_check_base< is_std_vector, scalar_type_t, TypeCheck, Check >... >
	Require none of the types satisfy is_std_vector.

Variables
template<typename T >
constexpr bool	stan::is_std_vector_v = is_std_vector<T>::value