picontainers.h doxygen partial
This commit is contained in:
@@ -1,12 +1,19 @@
|
||||
/*! @file picontainers.h
|
||||
* @brief Base for generic containers
|
||||
*
|
||||
* This file declare all containers and useful macros
|
||||
* to use them
|
||||
/*! \file picontainers.h
|
||||
* \brief
|
||||
* \~english Base macros for generic containers
|
||||
* \~russian Базовые макросы для контейнеров
|
||||
*
|
||||
* \authors
|
||||
* \~english
|
||||
* Ivan Pelipenko peri4ko@yandex.ru;
|
||||
* Andrey Bychkov work.a.b@yandex.ru;
|
||||
* \~russian
|
||||
* Иван Пелипенко peri4ko@yandex.ru;
|
||||
* Андрей Бычков work.a.b@yandex.ru;
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
Base for generic containers
|
||||
Base macros for generic containers
|
||||
Ivan Pelipenko peri4ko@yandex.ru
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
@@ -37,26 +44,9 @@
|
||||
#include <type_traits>
|
||||
#include <string.h>
|
||||
#include <new>
|
||||
#ifndef PIP_MEMALIGN_BYTES
|
||||
# define PIP_MEMALIGN_BYTES (sizeof(void*)*4)
|
||||
#endif
|
||||
#ifdef WINDOWS
|
||||
# ifdef CC_GCC
|
||||
# define amalloc(s) __mingw_aligned_malloc(s, PIP_MEMALIGN_BYTES)
|
||||
# define afree(p) __mingw_aligned_free(p)
|
||||
# else
|
||||
# ifdef CC_VC
|
||||
# define amalloc(s) _aligned_malloc(s, PIP_MEMALIGN_BYTES)
|
||||
# define afree(p) _aligned_free(p)
|
||||
# endif
|
||||
# endif
|
||||
#else
|
||||
# define amalloc(s) aligned_alloc(PIP_MEMALIGN_BYTES, s)
|
||||
# define afree(p) free(p)
|
||||
#endif
|
||||
|
||||
|
||||
#ifdef DOXYGEN
|
||||
#if 0
|
||||
|
||||
/*!@brief Macro for iterate any container
|
||||
* \details Use this macros instead of standard "for"
|
||||
@@ -94,26 +84,64 @@
|
||||
|
||||
|
||||
template <typename C>
|
||||
struct _reverse_wrapper {
|
||||
C & c_;
|
||||
_reverse_wrapper(C & c): c_(c) {}
|
||||
_reverse_wrapper(const C & c): c_(const_cast<C&>(c)) {}
|
||||
class _PIReverseWrapper {
|
||||
public:
|
||||
_PIReverseWrapper(C & c): c_(c) {}
|
||||
_PIReverseWrapper(const C & c): c_(const_cast<C&>(c)) {}
|
||||
typename C::reverse_iterator begin() {return c_.rbegin();}
|
||||
typename C::reverse_iterator end() {return c_.rend(); }
|
||||
typename C::const_reverse_iterator begin() const {return c_.rbegin();}
|
||||
typename C::const_reverse_iterator end() const {return c_.rend(); }
|
||||
private:
|
||||
C & c_;
|
||||
};
|
||||
|
||||
template <typename C> _reverse_wrapper<C> _reverse_wrap(C & c) {return _reverse_wrapper<C>(c);}
|
||||
template <typename C> _reverse_wrapper<C> _reverse_wrap(const C & c) {return _reverse_wrapper<C>(c);}
|
||||
template <typename C> _PIReverseWrapper<C> PIReverseWrap(C & c) {return _PIReverseWrapper<C>(c);}
|
||||
template <typename C> _PIReverseWrapper<C> PIReverseWrap(const C & c) {return _PIReverseWrapper<C>(c);}
|
||||
|
||||
|
||||
# define piForTimes(c) for(int _i##c = 0; _i##c < c; ++_i##c)
|
||||
/*! \brief
|
||||
* \~english Macro for short replacement of standart "for"
|
||||
* \~russian Макрос для короткой записи стандартного цикла "for"
|
||||
* \param c
|
||||
* \~english Iteration times in loop
|
||||
* \~russian Количество итераций цикла
|
||||
*/
|
||||
#define piForTimes(c) for(int _i##c = 0; _i##c < c; ++_i##c)
|
||||
|
||||
# define piForeach(i,c) for(i : c)
|
||||
# define piForeachC(i,c) for(const i : c)
|
||||
# define piForeachR(i,c) for(i : _reverse_wrap(c))
|
||||
# define piForeachRC(i,c) for(const i : _reverse_wrap(c))
|
||||
|
||||
/*! \brief
|
||||
* \~english Macro for iterate any container
|
||||
* \~russian Макрос для перебора любых контейнеров
|
||||
* \deprecated
|
||||
* \~english Deprecated, using only for backward compatibility. Use "c++ range for".
|
||||
* \~russian Устарело, используется только для обратной совместимости. Используйте "c++ range for".
|
||||
* \details
|
||||
* \~english Get read/write access to each element of container.
|
||||
* Iterating in forward direction.
|
||||
* Example of using:
|
||||
* \~russian Перебор всех элементов контейнера с доступом на чтение и запись.
|
||||
* Перебор осуществляется в прямом порядке.
|
||||
* Пример использования:
|
||||
* \code
|
||||
* PIVector<int> vec;
|
||||
* vec << 1 << 2 << 3;
|
||||
* piForeach(int & i, vec) piCout << i;
|
||||
* // 1
|
||||
* // 2
|
||||
* // 3
|
||||
* piForeach(int & i, vec) i++;
|
||||
* piForeach(int & i, vec) piCout << i;
|
||||
* // 2
|
||||
* // 3
|
||||
* // 4
|
||||
* \endcode
|
||||
*/
|
||||
#define piForeach(i, c) for(i : c)
|
||||
|
||||
#define piForeachC(i, c) for(const i : c)
|
||||
#define piForeachR(i, c) for(i : PIReverseWrap(c))
|
||||
#define piForeachRC(i, c) for(const i : PIReverseWrap(c))
|
||||
|
||||
# define piForeachCR piForeachRC
|
||||
|
||||
|
||||
Reference in New Issue
Block a user