# HG changeset patch # User Chris Cannam # Date 1466776065 -3600 # Node ID 5d0a2ebb4d17b2a265b76ae269ae4f45c2643c82 # Parent 112766f4c34b6988c63f47c64f58c5db0a6fc443 Bring dependent libraries in to repo diff -r 112766f4c34b -r 5d0a2ebb4d17 .hgsub --- a/.hgsub Wed Oct 07 16:51:54 2015 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,3 +0,0 @@ -constant-q-cpp = https://code.soundsoftware.ac.uk/hg/constant-q-cpp -bqvec = https://bitbucket.org/breakfastquay/bqvec -flattendynamics = https://code.soundsoftware.ac.uk/hg/flattendynamics diff -r 112766f4c34b -r 5d0a2ebb4d17 .hgsubstate --- a/.hgsubstate Wed Oct 07 16:51:54 2015 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,3 +0,0 @@ -7a48704e9a0fac1486240f9f7b7e31436a588064 bqvec -100430c32a259ac2f80776da0f8484029dc705c1 constant-q-cpp -d25a2e91e9d84aaff25e5d746398232d182d127d flattendynamics diff -r 112766f4c34b -r 5d0a2ebb4d17 bqvec/.hgignore --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bqvec/.hgignore Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,11 @@ +syntax: glob +*~ +*.orig +*.o +*.bak +*.so +*.dylib +*.dll +*.a +*.lib + diff -r 112766f4c34b -r 5d0a2ebb4d17 bqvec/COPYING --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bqvec/COPYING Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,50 @@ + +The following terms apply to the code in the src/ directory: + + Copyright 2007-2014 Particular Programs Ltd. + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, copy, + modify, merge, publish, distribute, sublicense, and/or sell copies + of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR + ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF + CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + Except as contained in this notice, the names of Chris Cannam and + Particular Programs Ltd shall not be used in advertising or + otherwise to promote the sale, use or other dealings in this + Software without prior written authorization. + + +The following terms apply to the code in the pommier/ directory: + + Copyright (C) 2011 Julien Pommier + + This software is provided 'as-is', without any express or implied + warranty. In no event will the authors be held liable for any damages + arising from the use of this software. + + Permission is granted to anyone to use this software for any purpose, + including commercial applications, and to alter it and redistribute it + freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. + 2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + 3. This notice may not be removed or altered from any source distribution. + diff -r 112766f4c34b -r 5d0a2ebb4d17 bqvec/Makefile --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bqvec/Makefile Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,88 @@ + +# Add to VECTOR_DEFINES the relevant options for your desired +# third-party library support. +# +# Available options are +# +# -DHAVE_IPP Intel's Integrated Performance Primitives are available +# -DHAVE_VDSP Apple's Accelerate framework is available +# +# These are optional (they affect performance, not function) and you +# may define more than one of them. +# +# Add any relevant -I flags for include paths as well. +# +# Note that you must supply the same flags when including bqvec +# headers later as you are using now when compiling the library. (You +# may find it simplest to just add the bqvec source files to your +# application's build system and not build a bqvec library at all.) + +VECTOR_DEFINES := + + +# Add to ALLOCATOR_DEFINES options relating to aligned malloc. +# +# Available options are +# +# -DHAVE_POSIX_MEMALIGN The posix_memalign call is available in sys/mman.h +# -DLACK_POSIX_MEMALIGN The posix_memalign call is not available +# +# -DMALLOC_IS_ALIGNED The malloc call already returns aligned memory +# -DMALLOC_IS_NOT_ALIGNED The malloc call does not return aligned memory +# +# -DUSE_OWN_ALIGNED_MALLOC No aligned malloc is available, roll your own +# +# -DLACK_BAD_ALLOC The C++ library lacks the std::bad_alloc exception +# +# Here "aligned" is assumed to mean "aligned enough for whatever +# vector stuff the space will be used for" which most likely means +# 16-byte alignment. +# +# The default is to use _aligned_malloc when building with Visual C++, +# system malloc when building on OS/X, and posix_memalign otherwise. +# +# Note that you must supply the same flags when including bqvec +# headers later as you are using now when compiling the library. (You +# may find it simplest to just add the bqvec source files to your +# application's build system and not build a bqvec library at all.) + +ALLOCATOR_DEFINES := + + +SRC_DIR := src +HEADER_DIR := bqvec + +SOURCES := $(wildcard $(SRC_DIR)/*.cpp) +HEADERS := $(wildcard $(HEADER_DIR)/*.h) $(wildcard $(SRC_DIR)/*.h) + +OBJECTS := $(SOURCES:.cpp=.o) +OBJECTS := $(OBJECTS:.c=.o) + +CXXFLAGS := $(VECTOR_DEFINES) $(ALLOCATOR_DEFINES) -I. + +LIBRARY := libbqvec.a + +all: $(LIBRARY) + +$(LIBRARY): $(OBJECTS) + $(AR) rc $@ $^ + +clean: + rm -f $(OBJECTS) + +distclean: clean + rm -f $(LIBRARY) + +depend: + makedepend -Y -fMakefile $(SOURCES) $(HEADERS) + + +# DO NOT DELETE + +src/VectorOpsComplex.o: bqvec/VectorOpsComplex.h bqvec/VectorOps.h +src/VectorOpsComplex.o: bqvec/Restrict.h bqvec/ComplexTypes.h +src/Allocators.o: bqvec/Allocators.h bqvec/VectorOps.h bqvec/Restrict.h +bqvec/VectorOpsComplex.o: bqvec/VectorOps.h bqvec/Restrict.h +bqvec/VectorOpsComplex.o: bqvec/ComplexTypes.h +bqvec/VectorOps.o: bqvec/Restrict.h +bqvec/Allocators.o: bqvec/VectorOps.h bqvec/Restrict.h diff -r 112766f4c34b -r 5d0a2ebb4d17 bqvec/README.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bqvec/README.txt Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,15 @@ + +bqvec +===== + +A small library for efficient vector arithmetic and allocation in C++ +using raw C pointer arrays. + +Copyright 2007-2014 Particular Programs Ltd. + +This code originated as part of the Rubber Band Library written by the +same authors (see https://bitbucket.org/breakfastquay/rubberband/). +It has been pulled out into a separate library and relicensed under a +more permissive licence: a BSD/MIT-style licence, as opposed to the +GPL used for Rubber Band. See the file COPYING for details. + diff -r 112766f4c34b -r 5d0a2ebb4d17 bqvec/bqvec/Allocators.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bqvec/bqvec/Allocators.h Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,265 @@ +/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ + +/* + bqvec + + A small library for vector arithmetic and allocation in C++ using + raw C pointer arrays. + + Copyright 2007-2015 Particular Programs Ltd. + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, copy, + modify, merge, publish, distribute, sublicense, and/or sell copies + of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR + ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF + CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + Except as contained in this notice, the names of Chris Cannam and + Particular Programs Ltd shall not be used in advertising or + otherwise to promote the sale, use or other dealings in this + Software without prior written authorization. +*/ + +#ifndef BQVEC_ALLOCATORS_H +#define BQVEC_ALLOCATORS_H + +#include "VectorOps.h" + +#include // for std::bad_alloc +#include + +#ifndef HAVE_POSIX_MEMALIGN +#ifndef _WIN32 +#ifndef __APPLE__ +#ifndef LACK_POSIX_MEMALIGN +#define HAVE_POSIX_MEMALIGN +#endif +#endif +#endif +#endif + +#ifndef MALLOC_IS_NOT_ALIGNED +#ifdef __APPLE_ +#ifndef MALLOC_IS_ALIGNED +#define MALLOC_IS_ALIGNED +#endif +#endif +#endif + +#ifdef HAVE_POSIX_MEMALIGN +#include +#endif + +#ifdef LACK_BAD_ALLOC +namespace std { struct bad_alloc { }; } +#endif + +namespace breakfastquay { + +template +T *allocate(size_t count) +{ + void *ptr = 0; + // 32-byte alignment is required for at least OpenMAX + static const int alignment = 32; +#ifdef USE_OWN_ALIGNED_MALLOC + // Alignment must be a power of two, bigger than the pointer + // size. Stuff the actual malloc'd pointer in just before the + // returned value. This is the least desirable way to do this -- + // the other options below are all better + size_t allocd = count * sizeof(T) + alignment; + void *buf = malloc(allocd); + if (buf) { + char *adj = (char *)buf; + while ((unsigned long long)adj & (alignment-1)) --adj; + ptr = ((char *)adj) + alignment; + ((void **)ptr)[-1] = buf; + } +#else /* !USE_OWN_ALIGNED_MALLOC */ +#ifdef HAVE_POSIX_MEMALIGN + if (posix_memalign(&ptr, alignment, count * sizeof(T))) { + ptr = malloc(count * sizeof(T)); + } +#else /* !HAVE_POSIX_MEMALIGN */ +#ifdef __MSVC__ + ptr = _aligned_malloc(count * sizeof(T), alignment); +#else /* !__MSVC__ */ +#ifndef MALLOC_IS_ALIGNED +#error "No aligned malloc available: define MALLOC_IS_ALIGNED to stick with system malloc, HAVE_POSIX_MEMALIGN if posix_memalign is available, or USE_OWN_ALIGNED_MALLOC to roll our own" +#endif + // Note that malloc always aligns to 16 byte boundaries on OS/X + ptr = malloc(count * sizeof(T)); + (void)alignment; // avoid compiler warning for unused +#endif /* !__MSVC__ */ +#endif /* !HAVE_POSIX_MEMALIGN */ +#endif /* !USE_OWN_ALIGNED_MALLOC */ + if (!ptr) { +#ifndef NO_EXCEPTIONS + throw(std::bad_alloc()); +#else + abort(); +#endif + } + return (T *)ptr; +} + +#ifdef HAVE_IPP + +template <> +float *allocate(size_t count); + +template <> +double *allocate(size_t count); + +#endif + +template +T *allocate_and_zero(size_t count) +{ + T *ptr = allocate(count); + v_zero(ptr, count); + return ptr; +} + +template +void deallocate(T *ptr) +{ +#ifdef USE_OWN_ALIGNED_MALLOC + if (ptr) free(((void **)ptr)[-1]); +#else /* !USE_OWN_ALIGNED_MALLOC */ +#ifdef __MSVC__ + if (ptr) _aligned_free((void *)ptr); +#else /* !__MSVC__ */ + if (ptr) free((void *)ptr); +#endif /* !__MSVC__ */ +#endif /* !USE_OWN_ALIGNED_MALLOC */ +} + +#ifdef HAVE_IPP + +template <> +void deallocate(float *); + +template <> +void deallocate(double *); + +#endif + +/// Reallocate preserving contents but leaving additional memory uninitialised +template +T *reallocate(T *ptr, size_t oldcount, size_t count) +{ + T *newptr = allocate(count); + if (oldcount && ptr) { + v_copy(newptr, ptr, oldcount < count ? oldcount : count); + } + if (ptr) deallocate(ptr); + return newptr; +} + +/// Reallocate, zeroing all contents +template +T *reallocate_and_zero(T *ptr, size_t oldcount, size_t count) +{ + ptr = reallocate(ptr, oldcount, count); + v_zero(ptr, count); + return ptr; +} + +/// Reallocate preserving contents and zeroing any additional memory +template +T *reallocate_and_zero_extension(T *ptr, size_t oldcount, size_t count) +{ + ptr = reallocate(ptr, oldcount, count); + if (count > oldcount) v_zero(ptr + oldcount, count - oldcount); + return ptr; +} + +template +T **allocate_channels(size_t channels, size_t count) +{ + // We don't want to use the aligned allocate for the channel + // pointers, it might even make things slower + T **ptr = new T *[channels]; + for (size_t c = 0; c < channels; ++c) { + ptr[c] = allocate(count); + } + return ptr; +} + +template +T **allocate_and_zero_channels(size_t channels, size_t count) +{ + // We don't want to use the aligned allocate for the channel + // pointers, it might even make things slower + T **ptr = new T *[channels]; + for (size_t c = 0; c < channels; ++c) { + ptr[c] = allocate_and_zero(count); + } + return ptr; +} + +template +void deallocate_channels(T **ptr, size_t channels) +{ + if (!ptr) return; + for (size_t c = 0; c < channels; ++c) { + deallocate(ptr[c]); + } + delete[] ptr; +} + +template +T **reallocate_channels(T **ptr, + size_t oldchannels, size_t oldcount, + size_t channels, size_t count) +{ + T **newptr = allocate_channels(channels, count); + if (oldcount && ptr) { + v_copy_channels(newptr, ptr, channels, oldcount < count ? oldcount : count); + } + if (ptr) deallocate_channels(ptr, oldchannels); + return newptr; +} + +template +T **reallocate_and_zero_extend_channels(T **ptr, + size_t oldchannels, size_t oldcount, + size_t channels, size_t count) +{ + T **newptr = allocate_and_zero_channels(channels, count); + if (oldcount && ptr) { + v_copy_channels(newptr, ptr, channels, oldcount < count ? oldcount : count); + } + if (ptr) deallocate_channels(ptr, oldchannels); + return newptr; +} + +/// RAII class to call deallocate() on destruction +template +class Deallocator +{ +public: + Deallocator(T *t) : m_t(t) { } + ~Deallocator() { deallocate(m_t); } +private: + T *m_t; +}; + +} + +#endif + diff -r 112766f4c34b -r 5d0a2ebb4d17 bqvec/bqvec/ComplexTypes.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bqvec/bqvec/ComplexTypes.h Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,52 @@ +/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ + +/* + bqvec + + A small library for vector arithmetic and allocation in C++ using + raw C pointer arrays. + + Copyright 2007-2015 Particular Programs Ltd. + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, copy, + modify, merge, publish, distribute, sublicense, and/or sell copies + of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR + ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF + CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + Except as contained in this notice, the names of Chris Cannam and + Particular Programs Ltd shall not be used in advertising or + otherwise to promote the sale, use or other dealings in this + Software without prior written authorization. +*/ + +#ifndef BQVEC_COMPLEX_TYPES_H +#define BQVEC_COMPLEX_TYPES_H + +namespace breakfastquay { + +#ifndef NO_COMPLEX_TYPES +// Convertible with other complex types that store re+im consecutively +typedef double bq_complex_element_t; +struct bq_complex_t { + bq_complex_element_t re; + bq_complex_element_t im; +}; +#endif + +} + +#endif diff -r 112766f4c34b -r 5d0a2ebb4d17 bqvec/bqvec/Restrict.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bqvec/bqvec/Restrict.h Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,51 @@ +/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ + +/* + bqvec + + A small library for vector arithmetic and allocation in C++ using + raw C pointer arrays. + + Copyright 2007-2015 Particular Programs Ltd. + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, copy, + modify, merge, publish, distribute, sublicense, and/or sell copies + of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR + ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF + CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + Except as contained in this notice, the names of Chris Cannam and + Particular Programs Ltd shall not be used in advertising or + otherwise to promote the sale, use or other dealings in this + Software without prior written authorization. +*/ + +#ifndef BQVEC_RESTRICT_H +#define BQVEC_RESTRICT_H + +#ifdef __MSVC__ +#define BQ_R__ __restrict +#endif + +#ifdef __GNUC__ +#define BQ_R__ __restrict__ +#endif + +#ifndef BQ_R__ +#define BQ_R__ +#endif + +#endif diff -r 112766f4c34b -r 5d0a2ebb4d17 bqvec/bqvec/VectorOps.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bqvec/bqvec/VectorOps.h Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,1081 @@ +/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ + +/* + bqvec + + A small library for vector arithmetic and allocation in C++ using + raw C pointer arrays. + + Copyright 2007-2015 Particular Programs Ltd. + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, copy, + modify, merge, publish, distribute, sublicense, and/or sell copies + of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR + ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF + CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + Except as contained in this notice, the names of Chris Cannam and + Particular Programs Ltd shall not be used in advertising or + otherwise to promote the sale, use or other dealings in this + Software without prior written authorization. +*/ + +#ifndef BQVEC_VECTOR_OPS_H +#define BQVEC_VECTOR_OPS_H + +#ifdef HAVE_IPP +#ifndef _MSC_VER +#include +#endif +#include +#include +#endif + +#ifdef HAVE_VDSP +#include +#endif + +#include + +#include "Restrict.h" + +namespace breakfastquay { + +/** + * General principle: + * + * Write basic vector-manipulation loops in such a way as to promote + * the likelihood that a good current C++ compiler can auto-vectorize + * them (e.g. gcc-4.x with -ftree-vectorize). Provide calls out to + * supported vector libraries (e.g. IPP, Accelerate) where useful. + * No intrinsics or assembly. + * + * Argument ordering: + * + * If a function operates on one or more vector sequences in memory, + * they appear as pointers at the start of the argument list. If one + * vector is the "destination", it appears first, with "source" second + * if present (i.e. argument ordering follows memcpy). + * + * The final argument is always a count of the number of elements in + * each vector. + * + * Some functions operate on a set of vectors at once: their names all + * contain the text _channels, and the number of channels (i.e. number + * of vectors) is the argument before last. + * + * Any additional arguments, e.g. scale factors, appear between the + * vector pointers at the start and the counts at the end. + * + * The caller takes responsibility for ensuring that vector pointer + * arguments are not aliased, i.e. that vectors provided as separate + * arguments to the same function are distinct and do not overlap, + * except where documented. + */ + +/** + * v_zero + * + * Zero the elements in the given vector, of length \arg count. + */ +template +inline void v_zero(T *const BQ_R__ vec, + const int count) +{ + const T value = T(0); + for (int i = 0; i < count; ++i) { + vec[i] = value; + } +} + +#if defined HAVE_IPP +template<> +inline void v_zero(float *const BQ_R__ vec, + const int count) +{ + ippsZero_32f(vec, count); +} +template<> +inline void v_zero(double *const BQ_R__ vec, + const int count) +{ + ippsZero_64f(vec, count); +} +#elif defined HAVE_VDSP +template<> +inline void v_zero(float *const BQ_R__ vec, + const int count) +{ + vDSP_vclr(vec, 1, count); +} +template<> +inline void v_zero(double *const BQ_R__ vec, + const int count) +{ + vDSP_vclrD(vec, 1, count); +} +#endif + +/** + * v_zero_channels + * + * Zero the elements in the given set of \arg channels vectors, each + * of length \arg count. + */ +template +inline void v_zero_channels(T *const BQ_R__ *const BQ_R__ vec, + const int channels, + const int count) +{ + for (int c = 0; c < channels; ++c) { + v_zero(vec[c], count); + } +} + +/** + * v_set + * + * Set all of the elements in the given vector, of length \arg count, + * to \arg value. + */ +template +inline void v_set(T *const BQ_R__ vec, + const T value, + const int count) +{ + for (int i = 0; i < count; ++i) { + vec[i] = value; + } +} + +/** + * v_copy + * + * Copy the contents of the vector \arg src to the vector \arg dst, + * both of length \arg count. + * + * Caller guarantees that \arg src and \arg dst are non-overlapping. + */ +template +inline void v_copy(T *const BQ_R__ dst, + const T *const BQ_R__ src, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] = src[i]; + } +} + +#if defined HAVE_IPP +template<> +inline void v_copy(float *const BQ_R__ dst, + const float *const BQ_R__ src, + const int count) +{ + ippsCopy_32f(src, dst, count); +} +template<> +inline void v_copy(double *const BQ_R__ dst, + const double *const BQ_R__ src, + const int count) +{ + ippsCopy_64f(src, dst, count); +} +#endif + +/** + * v_copy_channels + * + * Copy the contents of the individual vectors in the set \arg src to + * the corresponding vectors in the set \arg dst. All vectors have + * length \arg count and there are \arg channels vectors in each set. + * + * Caller guarantees that all of the \arg src and \arg dst vectors are + * non-overlapping with each other. + */ +template +inline void v_copy_channels(T *const BQ_R__ *const BQ_R__ dst, + const T *const BQ_R__ *const BQ_R__ src, + const int channels, + const int count) +{ + for (int c = 0; c < channels; ++c) { + v_copy(dst[c], src[c], count); + } +} + +/** + * v_move + * + * Copy the contents of vector \arg src to the vector \arg dst, both + * of length \arg count. The two vectors may overlap. (If you know + * that they cannot overlap, use v_copy instead.) + */ +template +inline void v_move(T *const dst, // not BQ_R__ (aliased) + const T *const src, // not BQ_R__ (aliased) + const int count) +{ + memmove(dst, src, count * sizeof(T)); +} + +#if defined HAVE_IPP +template<> +inline void v_move(float *const dst, + const float *const src, + const int count) +{ + ippsMove_32f(src, dst, count); +} +template<> +inline void v_move(double *const dst, + const double *const src, + const int count) +{ + ippsMove_64f(src, dst, count); +} +#endif + +/** + * v_convert + * + * Copy the contents of vector \arg src to the vector \arg dst, both + * of length \arg count. The two vectors may have different value + * types, e.g. double and float. If they have the same type, this is + * equivalent to v_copy. + * + * Caller guarantees that \arg src and \arg dst are non-overlapping. + */ +template +inline void v_convert(U *const BQ_R__ dst, + const T *const BQ_R__ src, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] = U(src[i]); + } +} + +template<> +inline void v_convert(float *const BQ_R__ dst, + const float *const BQ_R__ src, + const int count) +{ + v_copy(dst, src, count); +} +template<> +inline void v_convert(double *const BQ_R__ dst, + const double *const BQ_R__ src, + const int count) +{ + v_copy(dst, src, count); +} + +#if defined HAVE_IPP +template<> +inline void v_convert(double *const BQ_R__ dst, + const float *const BQ_R__ src, + const int count) +{ + ippsConvert_32f64f(src, dst, count); +} +template<> +inline void v_convert(float *const BQ_R__ dst, + const double *const BQ_R__ src, + const int count) +{ + ippsConvert_64f32f(src, dst, count); +} +#elif defined HAVE_VDSP +template<> +inline void v_convert(double *const BQ_R__ dst, + const float *const BQ_R__ src, + const int count) +{ + vDSP_vspdp((float *)src, 1, dst, 1, count); +} +template<> +inline void v_convert(float *const BQ_R__ dst, + const double *const BQ_R__ src, + const int count) +{ + vDSP_vdpsp((double *)src, 1, dst, 1, count); +} +#endif + +/** + * v_convert_channels + * + * Copy the contents of the individual vectors in the set \arg src to + * the corresponding vectors in the set \arg dst. All vectors have + * length \arg count, and there are \arg channels vectors in each + * set. The source and destination vectors may have different value + * types, e.g. double and float. If they have the same type, this is + * equivalent to v_copy_channels. + * + * Caller guarantees that all of the \arg src and \arg dst vectors are + * non-overlapping with each other. + */ +template +inline void v_convert_channels(U *const BQ_R__ *const BQ_R__ dst, + const T *const BQ_R__ *const BQ_R__ src, + const int channels, + const int count) +{ + for (int c = 0; c < channels; ++c) { + v_convert(dst[c], src[c], count); + } +} + +/** + * v_add + * + * Add the elements in the vector \arg src to the corresponding + * elements in the vector \arg dst, both of length arg \count, leaving + * the result in \arg dst. + * + * Caller guarantees that \arg src and \arg dst are non-overlapping. + */ +template +inline void v_add(T *const BQ_R__ dst, + const T *const BQ_R__ src, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] += src[i]; + } +} + +/** + * v_add + * + * Add the constant \arg value to every element of the vector \arg + * dst, of length arg \count, leaving the result in \arg dst. + */ +template +inline void v_add(T *const BQ_R__ dst, + const T value, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] += value; + } +} + +#if defined HAVE_IPP +template<> +inline void v_add(float *const BQ_R__ dst, + const float *const BQ_R__ src, + const int count) +{ + ippsAdd_32f_I(src, dst, count); +} +inline void v_add(double *const BQ_R__ dst, + const double *const BQ_R__ src, + const int count) +{ + ippsAdd_64f_I(src, dst, count); +} +#endif + +/** + * v_add_channels + * + * Add the elements in the individual vectors in the set \arg src to + * the corresponding elements of the corresponding vectors in \arg + * dst, leaving the results in \arg dst. All vectors have length \arg + * count, and there are \arg channels vectors in each set. + * + * Caller guarantees that all of the \arg src and \arg dst vectors are + * non-overlapping with each other. + */ +template +inline void v_add_channels(T *const BQ_R__ *const BQ_R__ dst, + const T *const BQ_R__ *const BQ_R__ src, + const int channels, const int count) +{ + for (int c = 0; c < channels; ++c) { + v_add(dst[c], src[c], count); + } +} + +/** + * v_add_with_gain + * + * Add the elements in the vector \arg src, each multiplied by the + * constant factor \arg gain, to the corresponding elements in the + * vector \arg dst, both of length arg \count, leaving the result in + * \arg dst. + * + * Caller guarantees that \arg src and \arg dst are non-overlapping. + */ +template +inline void v_add_with_gain(T *const BQ_R__ dst, + const T *const BQ_R__ src, + const G gain, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] += src[i] * gain; + } +} + +/** + * v_add_channels_with_gain + * + * Add the elements in the individual vectors in the set \arg src, + * each multiplied by the constant factor \arg gain, to the + * corresponding elements of the corresponding vectors in \arg dst, + * leaving the results in \arg dst. All vectors have length \arg + * count, and there are \arg channels vectors in each set. + * + * Caller guarantees that all of the \arg src and \arg dst vectors are + * non-overlapping with each other. + */ +template +inline void v_add_channels_with_gain(T *const BQ_R__ *const BQ_R__ dst, + const T *const BQ_R__ *const BQ_R__ src, + const G gain, + const int channels, + const int count) +{ + for (int c = 0; c < channels; ++c) { + v_add_with_gain(dst[c], src[c], gain, count); + } +} + +/** + * v_subtract + * + * Subtract the elements in the vector \arg src from the corresponding + * elements in the vector \arg dst, both of length arg \count, leaving + * the result in \arg dst. + * + * Caller guarantees that \arg src and \arg dst are non-overlapping. + */ +template +inline void v_subtract(T *const BQ_R__ dst, + const T *const BQ_R__ src, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] -= src[i]; + } +} + +#if defined HAVE_IPP +template<> +inline void v_subtract(float *const BQ_R__ dst, + const float *const BQ_R__ src, + const int count) +{ + ippsSub_32f_I(src, dst, count); +} +inline void v_subtract(double *const BQ_R__ dst, + const double *const BQ_R__ src, + const int count) +{ + ippsSub_64f_I(src, dst, count); +} +#endif + +/** + * v_scale + * + * Scale the elements in the vector \arg dst, of length \arg count, by + * the factor \arg gain. + */ +template +inline void v_scale(T *const BQ_R__ dst, + const G gain, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] *= gain; + } +} + +#if defined HAVE_IPP +template<> +inline void v_scale(float *const BQ_R__ dst, + const float gain, + const int count) +{ + ippsMulC_32f_I(gain, dst, count); +} +template<> +inline void v_scale(double *const BQ_R__ dst, + const double gain, + const int count) +{ + ippsMulC_64f_I(gain, dst, count); +} +#endif + +/** + * v_multiply + * + * Multiply the elements in the vector \arg dst by the corresponding + * elements in the vector \arg src, both of length arg \count, leaving + * the result in \arg dst. + * + * Caller guarantees that \arg src and \arg dst are non-overlapping. + */ +template +inline void v_multiply(T *const BQ_R__ dst, + const T *const BQ_R__ src, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] *= src[i]; + } +} + +#if defined HAVE_IPP +template<> +inline void v_multiply(float *const BQ_R__ dst, + const float *const BQ_R__ src, + const int count) +{ + ippsMul_32f_I(src, dst, count); +} +template<> +inline void v_multiply(double *const BQ_R__ dst, + const double *const BQ_R__ src, + const int count) +{ + ippsMul_64f_I(src, dst, count); +} +#endif + +/** + * v_multiply + * + * Multiply the corresponding elements of the vectors \arg src1 and + * \arg src2, both of length arg \count, and write the results into + * \arg dst. + * + * Caller guarantees that \arg src1, \arg src2 and \arg dst are + * non-overlapping. + */ +template +inline void v_multiply(T *const BQ_R__ dst, + const T *const BQ_R__ src1, + const T *const BQ_R__ src2, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] = src1[i] * src2[i]; + } +} + +#if defined HAVE_IPP +template<> +inline void v_multiply(float *const BQ_R__ dst, + const float *const BQ_R__ src1, + const float *const BQ_R__ src2, + const int count) +{ + ippsMul_32f(src1, src2, dst, count); +} +template<> +inline void v_multiply(double *const BQ_R__ dst, + const double *const BQ_R__ src1, + const double *const BQ_R__ src2, + const int count) +{ + ippsMul_64f(src1, src2, dst, count); +} +#endif + +/** + * v_divide + * + * Divide the elements in the vector \arg dst by the corresponding + * elements in the vector \arg src, both of length arg \count, leaving + * the result in \arg dst. + * + * Caller guarantees that \arg src and \arg dst are non-overlapping. + */ +template +inline void v_divide(T *const BQ_R__ dst, + const T *const BQ_R__ src, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] /= src[i]; + } +} + +#if defined HAVE_IPP +template<> +inline void v_divide(float *const BQ_R__ dst, + const float *const BQ_R__ src, + const int count) +{ + ippsDiv_32f_I(src, dst, count); +} +template<> +inline void v_divide(double *const BQ_R__ dst, + const double *const BQ_R__ src, + const int count) +{ + ippsDiv_64f_I(src, dst, count); +} +#endif + +/** + * v_multiply_and_add + * + * Multiply the corresponding elements of the vectors \arg src1 and + * \arg src2, both of length arg \count, and add the results to the + * corresponding elements of vector \arg dst. + * + * Caller guarantees that \arg src1, \arg src2 and \arg dst are + * non-overlapping. + */ +template +inline void v_multiply_and_add(T *const BQ_R__ dst, + const T *const BQ_R__ src1, + const T *const BQ_R__ src2, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] += src1[i] * src2[i]; + } +} + +#if defined HAVE_IPP +template<> +inline void v_multiply_and_add(float *const BQ_R__ dst, + const float *const BQ_R__ src1, + const float *const BQ_R__ src2, + const int count) +{ + ippsAddProduct_32f(src1, src2, dst, count); +} +template<> +inline void v_multiply_and_add(double *const BQ_R__ dst, + const double *const BQ_R__ src1, + const double *const BQ_R__ src2, + const int count) +{ + ippsAddProduct_64f(src1, src2, dst, count); +} +#endif + +/** + * v_sum + * + * Return the sum of the elements in vector \arg src, of length \arg + * count. + */ +template +inline T v_sum(const T *const BQ_R__ src, + const int count) +{ + T result = T(); + for (int i = 0; i < count; ++i) { + result += src[i]; + } + return result; +} + +/** + * v_log + * + * Replace each element in vector \arg dst, of length \arg count, with + * its natural logarithm. + */ +template +inline void v_log(T *const BQ_R__ dst, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] = log(dst[i]); + } +} + +#if defined HAVE_IPP +template<> +inline void v_log(float *const BQ_R__ dst, + const int count) +{ + ippsLn_32f_I(dst, count); +} +template<> +inline void v_log(double *const BQ_R__ dst, + const int count) +{ + ippsLn_64f_I(dst, count); +} +#elif defined HAVE_VDSP +// no in-place vForce functions for these -- can we use the +// out-of-place functions with equal input and output vectors? can we +// use an out-of-place one with temporary buffer and still be faster +// than doing it any other way? +template<> +inline void v_log(float *const BQ_R__ dst, + const int count) +{ + float tmp[count]; + vvlogf(tmp, dst, &count); + v_copy(dst, tmp, count); +} +template<> +inline void v_log(double *const BQ_R__ dst, + const int count) +{ + double tmp[count]; + vvlog(tmp, dst, &count); + v_copy(dst, tmp, count); +} +#endif + +/** + * v_exp + * + * Replace each element in vector \arg dst, of length \arg count, with + * its base-e exponential. + */ +template +inline void v_exp(T *const BQ_R__ dst, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] = exp(dst[i]); + } +} + +#if defined HAVE_IPP +template<> +inline void v_exp(float *const BQ_R__ dst, + const int count) +{ + ippsExp_32f_I(dst, count); +} +template<> +inline void v_exp(double *const BQ_R__ dst, + const int count) +{ + ippsExp_64f_I(dst, count); +} +#elif defined HAVE_VDSP +// no in-place vForce functions for these -- can we use the +// out-of-place functions with equal input and output vectors? can we +// use an out-of-place one with temporary buffer and still be faster +// than doing it any other way? +template<> +inline void v_exp(float *const BQ_R__ dst, + const int count) +{ + float tmp[count]; + vvexpf(tmp, dst, &count); + v_copy(dst, tmp, count); +} +template<> +inline void v_exp(double *const BQ_R__ dst, + const int count) +{ + double tmp[count]; + vvexp(tmp, dst, &count); + v_copy(dst, tmp, count); +} +#endif + +/** + * v_sqrt + * + * Replace each element in vector \arg dst, of length \arg count, with + * its square root. + */ +template +inline void v_sqrt(T *const BQ_R__ dst, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] = sqrt(dst[i]); + } +} + +#if defined HAVE_IPP +template<> +inline void v_sqrt(float *const BQ_R__ dst, + const int count) +{ + ippsSqrt_32f_I(dst, count); +} +template<> +inline void v_sqrt(double *const BQ_R__ dst, + const int count) +{ + ippsSqrt_64f_I(dst, count); +} +#elif defined HAVE_VDSP +// no in-place vForce functions for these -- can we use the +// out-of-place functions with equal input and output vectors? can we +// use an out-of-place one with temporary buffer and still be faster +// than doing it any other way? +template<> +inline void v_sqrt(float *const BQ_R__ dst, + const int count) +{ + float tmp[count]; + vvsqrtf(tmp, dst, &count); + v_copy(dst, tmp, count); +} +template<> +inline void v_sqrt(double *const BQ_R__ dst, + const int count) +{ + double tmp[count]; + vvsqrt(tmp, dst, &count); + v_copy(dst, tmp, count); +} +#endif + +/** + * v_square + * + * Replace each element in vector \arg dst, of length \arg count, with + * its square. + */ +template +inline void v_square(T *const BQ_R__ dst, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] = dst[i] * dst[i]; + } +} + +#if defined HAVE_IPP +template<> +inline void v_square(float *const BQ_R__ dst, + const int count) +{ + ippsSqr_32f_I(dst, count); +} +template<> +inline void v_square(double *const BQ_R__ dst, + const int count) +{ + ippsSqr_64f_I(dst, count); +} +#endif + +/** + * v_abs + * + * Replace each element in vector \arg dst, of length \arg count, with + * its absolute value. + */ +template +inline void v_abs(T *const BQ_R__ dst, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] = fabs(dst[i]); + } +} + +#if defined HAVE_IPP +template<> +inline void v_abs(float *const BQ_R__ dst, + const int count) +{ + ippsAbs_32f_I(dst, count); +} +template<> +inline void v_abs(double *const BQ_R__ dst, + const int count) +{ + ippsAbs_64f_I(dst, count); +} +#elif defined HAVE_VDSP +template<> +inline void v_abs(float *const BQ_R__ dst, + const int count) +{ + float tmp[count]; +#if (defined(MACOSX_DEPLOYMENT_TARGET) && MACOSX_DEPLOYMENT_TARGET <= 1070 && MAC_OS_X_VERSION_MIN_REQUIRED <= 1070) + vvfabf(tmp, dst, &count); +#else + vvfabsf(tmp, dst, &count); +#endif + v_copy(dst, tmp, count); +} +#endif + +/** + * v_interleave + * + * Interleave (zip) the \arg channels vectors in \arg src, each of + * length \arg count, into the single vector \arg dst of length \arg + * channels * \arg count. + * + * Caller guarantees that the \arg src and \arg dst vectors are + * non-overlapping. + */ +template +inline void v_interleave(T *const BQ_R__ dst, + const T *const BQ_R__ *const BQ_R__ src, + const int channels, + const int count) +{ + int idx = 0; + switch (channels) { + case 2: + // common case, may be vectorized by compiler if hardcoded + for (int i = 0; i < count; ++i) { + for (int j = 0; j < 2; ++j) { + dst[idx++] = src[j][i]; + } + } + return; + case 1: + v_copy(dst, src[0], count); + return; + default: + for (int i = 0; i < count; ++i) { + for (int j = 0; j < channels; ++j) { + dst[idx++] = src[j][i]; + } + } + } +} + +#if defined HAVE_IPP +template<> +inline void v_interleave(float *const BQ_R__ dst, + const float *const BQ_R__ *const BQ_R__ src, + const int channels, + const int count) +{ + ippsInterleave_32f((const Ipp32f **)src, channels, count, dst); +} +// IPP does not (currently?) provide double-precision interleave +#endif + +/** + * v_deinterleave + * + * Deinterleave (unzip) the single vector \arg src, of length \arg + * channels * \arg count, into the \arg channels vectors in \arg dst, + * each of length \arg count. + * + * Caller guarantees that the \arg src and \arg dst vectors are + * non-overlapping. + */ +template +inline void v_deinterleave(T *const BQ_R__ *const BQ_R__ dst, + const T *const BQ_R__ src, + const int channels, + const int count) +{ + int idx = 0; + switch (channels) { + case 2: + // common case, may be vectorized by compiler if hardcoded + for (int i = 0; i < count; ++i) { + for (int j = 0; j < 2; ++j) { + dst[j][i] = src[idx++]; + } + } + return; + case 1: + v_copy(dst[0], src, count); + return; + default: + for (int i = 0; i < count; ++i) { + for (int j = 0; j < channels; ++j) { + dst[j][i] = src[idx++]; + } + } + } +} + +#if defined HAVE_IPP +template<> +inline void v_deinterleave(float *const BQ_R__ *const BQ_R__ dst, + const float *const BQ_R__ src, + const int channels, + const int count) +{ + ippsDeinterleave_32f((const Ipp32f *)src, channels, count, (Ipp32f **)dst); +} +// IPP does not (currently?) provide double-precision deinterleave +#endif + +/** + * v_fftshift + * + * Perform an in-place left-right shift of the vector \arg vec of + * length \arg count, swapping the first and second halves of the + * vector. + */ +template +inline void v_fftshift(T *const BQ_R__ vec, + const int count) +{ + const int hs = count/2; + for (int i = 0; i < hs; ++i) { + T t = vec[i]; + vec[i] = vec[i + hs]; + vec[i + hs] = t; + } +} + +/** + * v_mean + * + * Return the mean of the values in the vector \arg vec, of length + * \arg count. + */ +template +inline T v_mean(const T *const BQ_R__ vec, const int count) +{ + T t = T(0); + for (int i = 0; i < count; ++i) { + t += vec[i]; + } + t /= T(count); + return t; +} + +/** + * v_mean_channels + * + * Return the mean of all the values in the set of \arg channels + * vectors in \arg vec, each of length \arg count. (This is the single + * mean of all values across all channels, not one mean per channel.) + */ +template +inline T v_mean_channels(const T *const BQ_R__ *const BQ_R__ vec, + const int channels, + const int count) +{ + T t = T(0); + for (int c = 0; c < channels; ++c) { + t += v_mean(vec[c], count); + } + t /= T(channels); + return t; +} + +} + +#endif diff -r 112766f4c34b -r 5d0a2ebb4d17 bqvec/bqvec/VectorOpsComplex.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bqvec/bqvec/VectorOpsComplex.h Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,548 @@ +/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ + +/* + bqvec + + A small library for vector arithmetic and allocation in C++ using + raw C pointer arrays. + + Copyright 2007-2015 Particular Programs Ltd. + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, copy, + modify, merge, publish, distribute, sublicense, and/or sell copies + of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR + ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF + CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + Except as contained in this notice, the names of Chris Cannam and + Particular Programs Ltd shall not be used in advertising or + otherwise to promote the sale, use or other dealings in this + Software without prior written authorization. +*/ + +#ifndef BQVEC_VECTOR_OPS_COMPLEX_H +#define BQVEC_VECTOR_OPS_COMPLEX_H + +#include "VectorOps.h" +#include "ComplexTypes.h" + +#include + +namespace breakfastquay { + +#ifndef NO_COMPLEX_TYPES + +template<> +inline void v_zero(bq_complex_t *const BQ_R__ ptr, + const int count) +{ +#if defined HAVE_IPP + if (sizeof(bq_complex_element_t) == sizeof(float)) { + ippsZero_32fc((Ipp32fc *)ptr, count); + } else { + ippsZero_64fc((Ipp64fc *)ptr, count); + } +#elif defined HAVE_VDSP + if (sizeof(bq_complex_element_t) == sizeof(float)) { + vDSP_vclr((float *)ptr, 1, count * 2); + } else { + vDSP_vclrD((double *)ptr, 1, count * 2); + } +#else + const bq_complex_element_t value = 0.0; + for (int i = 0; i < count; ++i) { + ptr[i].re = value; + ptr[i].im = value; + } +#endif +} + +#if defined HAVE_IPP +template<> +inline void v_copy(bq_complex_t *const BQ_R__ dst, + const bq_complex_t *const BQ_R__ src, + const int count) +{ + if (sizeof(bq_complex_element_t) == sizeof(float)) { + ippsCopy_32fc((const Ipp32fc *)src, (Ipp32fc *)dst, count); + } else { + ippsCopy_64fc((const Ipp64fc *)src, (Ipp64fc *)dst, count); + } +} +template<> +inline void v_move(bq_complex_t *const BQ_R__ dst, + const bq_complex_t *const BQ_R__ src, + const int count) +{ + if (sizeof(bq_complex_element_t) == sizeof(float)) { + ippsMove_32fc((const Ipp32fc *)src, (Ipp32fc *)dst, count); + } else { + ippsMove_64fc((const Ipp64fc *)src, (Ipp64fc *)dst, count); + } +} +#endif + +template<> +inline void v_convert(bq_complex_t *const BQ_R__ dst, + const bq_complex_element_t *const BQ_R__ src, + const int srccount) +{ + const int targetcount = srccount / 2; + int srcidx = 0; + for (int i = 0; i < targetcount; ++i) { + dst[i].re = src[srcidx++]; + dst[i].im = src[srcidx++]; + } +} + +template<> +inline void v_convert(bq_complex_element_t *const BQ_R__ dst, + const bq_complex_t *const BQ_R__ src, + const int srccount) +{ + int targetidx = 0; + for (int i = 0; i < srccount; ++i) { + dst[targetidx++] = src[i].re; + dst[targetidx++] = src[i].im; + } +} + +inline void c_add(bq_complex_t &dst, + const bq_complex_t &src) +{ + dst.re += src.re; + dst.im += src.im; +} + +inline void c_add_with_gain(bq_complex_t &dst, + const bq_complex_t &src, + const bq_complex_element_t gain) +{ + dst.re += src.re * gain; + dst.im += src.im * gain; +} + +inline void c_multiply(bq_complex_t &dst, + const bq_complex_t &src1, + const bq_complex_t &src2) +{ + // Note dst may alias src1 or src2. + + // The usual formula -- four multiplies, one add and one subtract + // + // (x1 + y1i)(x2 + y2i) = (x1x2 - y1y2) + (x1y2 + y1x2)i + // + // Alternative formula -- three multiplies, two adds, three + // subtracts + // + // (x1 + y1i)(x2 + y2i) = (x1x2 - y1y2) + ((x1 + y1)(x2 + y2) - x1x2 - y1y2)i + // + // The first formulation tests marginally quicker here. + + bq_complex_element_t real = src1.re * src2.re - src1.im * src2.im; + bq_complex_element_t imag = src1.re * src2.im + src1.im * src2.re; + + dst.re = real; + dst.im = imag; +} + +inline void c_multiply(bq_complex_t &dst, + const bq_complex_t &src) +{ + c_multiply(dst, dst, src); +} + +inline void c_multiply_and_add(bq_complex_t &dst, + const bq_complex_t &src1, + const bq_complex_t &src2) +{ + bq_complex_t tmp; + c_multiply(tmp, src1, src2); + c_add(dst, tmp); +} + +template<> +inline void v_add(bq_complex_t *const BQ_R__ dst, + const bq_complex_t *const BQ_R__ src, + const int count) +{ +#if defined HAVE_IPP + if (sizeof(bq_complex_element_t) == sizeof(float)) { + ippsAdd_32fc_I((Ipp32fc *)src, (Ipp32fc *)dst, count); + } else { + ippsAdd_64fc_I((Ipp64fc *)src, (Ipp64fc *)dst, count); + } +#else + for (int i = 0; i < count; ++i) { + dst[i].re += src[i].re; + dst[i].im += src[i].im; + } +#endif +} + +template<> +inline void v_add_with_gain(bq_complex_t *const BQ_R__ dst, + const bq_complex_t *const BQ_R__ src, + const bq_complex_element_t gain, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i].re += src[i].re * gain; + dst[i].im += src[i].im * gain; + } +} + +template<> +inline void v_multiply(bq_complex_t *const BQ_R__ dst, + const bq_complex_t *const BQ_R__ src, + const int count) +{ +#ifdef HAVE_IPP + if (sizeof(bq_complex_element_t) == sizeof(float)) { + ippsMul_32fc_I((const Ipp32fc *)src, (Ipp32fc *)dst, count); + } else { + ippsMul_64fc_I((const Ipp64fc *)src, (Ipp64fc *)dst, count); + } +#else + for (int i = 0; i < count; ++i) { + c_multiply(dst[i], src[i]); + } +#endif +} + +template<> +inline void v_multiply(bq_complex_t *const BQ_R__ dst, + const bq_complex_t *const BQ_R__ src1, + const bq_complex_t *const BQ_R__ src2, + const int count) +{ +#ifdef HAVE_IPP + if (sizeof(bq_complex_element_t) == sizeof(float)) { + ippsMul_32fc((const Ipp32fc *)src1, (const Ipp32fc *)src2, + (Ipp32fc *)dst, count); + } else { + ippsMul_64fc((const Ipp64fc *)src1, (const Ipp64fc *)src2, + (Ipp64fc *)dst, count); + } +#else + for (int i = 0; i < count; ++i) { + c_multiply(dst[i], src1[i], src2[i]); + } +#endif +} + +template<> +inline void v_multiply_and_add(bq_complex_t *const BQ_R__ dst, + const bq_complex_t *const BQ_R__ src1, + const bq_complex_t *const BQ_R__ src2, + const int count) +{ +#ifdef HAVE_IPP + if (sizeof(bq_complex_element_t) == sizeof(float)) { + ippsAddProduct_32fc((const Ipp32fc *)src1, (const Ipp32fc *)src2, + (Ipp32fc *)dst, count); + } else { + ippsAddProduct_64fc((const Ipp64fc *)src1, (const Ipp64fc *)src2, + (Ipp64fc *)dst, count); + } +#else + for (int i = 0; i < count; ++i) { + c_multiply_and_add(dst[i], src1[i], src2[i]); + } +#endif +} + +#if defined( __GNUC__ ) && defined( _WIN32 ) +// MinGW doesn't appear to have sincos, so define it -- it's +// a single x87 instruction anyway +static inline void sincos(double x, double *sin, double *cos) { + __asm__ ("fsincos;" : "=t" (*cos), "=u" (*sin) : "0" (x) : "st(7)"); +} +static inline void sincosf(float fx, float *fsin, float *fcos) { + double sin, cos; + sincos(fx, &sin, &cos); + *fsin = sin; + *fcos = cos; +} +#endif + +#endif /* !NO_COMPLEX_TYPES */ + +template +inline void c_phasor(T *real, T *imag, T phase) +{ + //!!! IPP contains ippsSinCos_xxx in ippvm.h -- these are + //!!! fixed-accuracy, test and compare +#if defined HAVE_VDSP + int one = 1; + if (sizeof(T) == sizeof(float)) { + vvsincosf((float *)imag, (float *)real, (const float *)&phase, &one); + } else { + vvsincos((double *)imag, (double *)real, (const double *)&phase, &one); + } +#elif defined LACK_SINCOS + if (sizeof(T) == sizeof(float)) { + *real = cosf(phase); + *imag = sinf(phase); + } else { + *real = cos(phase); + *imag = sin(phase); + } +#elif defined __GNUC__ + if (sizeof(T) == sizeof(float)) { + sincosf(phase, (float *)imag, (float *)real); + } else { + sincos(phase, (double *)imag, (double *)real); + } +#else + if (sizeof(T) == sizeof(float)) { + *real = cosf(phase); + *imag = sinf(phase); + } else { + *real = cos(phase); + *imag = sin(phase); + } +#endif +} + +template +inline void c_magphase(T *mag, T *phase, T real, T imag) +{ + *mag = sqrt(real * real + imag * imag); + *phase = atan2(imag, real); +} + +#ifdef USE_APPROXIMATE_ATAN2 +// NB arguments in opposite order from usual for atan2f +extern float approximate_atan2f(float real, float imag); +template<> +inline void c_magphase(float *mag, float *phase, float real, float imag) +{ + float atan = approximate_atan2f(real, imag); + *phase = atan; + *mag = sqrtf(real * real + imag * imag); +} +#else +template<> +inline void c_magphase(float *mag, float *phase, float real, float imag) +{ + *mag = sqrtf(real * real + imag * imag); + *phase = atan2f(imag, real); +} +#endif + +#ifndef NO_COMPLEX_TYPES + +inline bq_complex_t c_phasor(bq_complex_element_t phase) +{ + bq_complex_t c; + c_phasor(&c.re, &c.im, phase); + return c; +} + +inline void c_magphase(bq_complex_element_t *mag, bq_complex_element_t *phase, + bq_complex_t c) +{ + c_magphase(mag, phase, c.re, c.im); +} + +void v_polar_to_cartesian(bq_complex_t *const BQ_R__ dst, + const bq_complex_element_t *const BQ_R__ mag, + const bq_complex_element_t *const BQ_R__ phase, + const int count); + +void v_polar_interleaved_to_cartesian(bq_complex_t *const BQ_R__ dst, + const bq_complex_element_t *const BQ_R__ src, + const int count); + +inline void v_cartesian_to_polar(bq_complex_element_t *const BQ_R__ mag, + bq_complex_element_t *const BQ_R__ phase, + const bq_complex_t *const BQ_R__ src, + const int count) +{ + for (int i = 0; i < count; ++i) { + c_magphase(mag + i, phase + i, src[i].re, src[i].im); + } +} + +inline void v_cartesian_to_polar_interleaved(bq_complex_element_t *const BQ_R__ dst, + const bq_complex_t *const BQ_R__ src, + const int count) +{ + for (int i = 0; i < count; ++i) { + c_magphase(&dst[i*2], &dst[i*2+1], + src[i].re, src[i].im); + } +} + +#endif /* !NO_COMPLEX_TYPES */ + +template // S source, T target +void v_polar_to_cartesian(T *const BQ_R__ real, + T *const BQ_R__ imag, + const S *const BQ_R__ mag, + const S *const BQ_R__ phase, + const int count) +{ + for (int i = 0; i < count; ++i) { + c_phasor(real + i, imag + i, phase[i]); + } + v_multiply(real, mag, count); + v_multiply(imag, mag, count); +} + +template +void v_polar_interleaved_to_cartesian_inplace(T *const BQ_R__ srcdst, + const int count) +{ + T real, imag; + for (int i = 0; i < count*2; i += 2) { + c_phasor(&real, &imag, srcdst[i+1]); + real *= srcdst[i]; + imag *= srcdst[i]; + srcdst[i] = real; + srcdst[i+1] = imag; + } +} + +template // S source, T target +void v_polar_to_cartesian_interleaved(T *const BQ_R__ dst, + const S *const BQ_R__ mag, + const S *const BQ_R__ phase, + const int count) +{ + T real, imag; + for (int i = 0; i < count; ++i) { + c_phasor(&real, &imag, phase[i]); + real *= mag[i]; + imag *= mag[i]; + dst[i*2] = real; + dst[i*2+1] = imag; + } +} + +#if defined USE_POMMIER_MATHFUN +void v_polar_to_cartesian_pommier(float *const BQ_R__ real, + float *const BQ_R__ imag, + const float *const BQ_R__ mag, + const float *const BQ_R__ phase, + const int count); +void v_polar_interleaved_to_cartesian_inplace_pommier(float *const BQ_R__ srcdst, + const int count); +void v_polar_to_cartesian_interleaved_pommier(float *const BQ_R__ dst, + const float *const BQ_R__ mag, + const float *const BQ_R__ phase, + const int count); + +template<> +inline void v_polar_to_cartesian(float *const BQ_R__ real, + float *const BQ_R__ imag, + const float *const BQ_R__ mag, + const float *const BQ_R__ phase, + const int count) +{ + v_polar_to_cartesian_pommier(real, imag, mag, phase, count); +} + +template<> +inline void v_polar_interleaved_to_cartesian_inplace(float *const BQ_R__ srcdst, + const int count) +{ + v_polar_interleaved_to_cartesian_inplace_pommier(srcdst, count); +} + +template<> +inline void v_polar_to_cartesian_interleaved(float *const BQ_R__ dst, + const float *const BQ_R__ mag, + const float *const BQ_R__ phase, + const int count) +{ + v_polar_to_cartesian_interleaved_pommier(dst, mag, phase, count); +} + +#endif + +template // S source, T target +void v_cartesian_to_polar(T *const BQ_R__ mag, + T *const BQ_R__ phase, + const S *const BQ_R__ real, + const S *const BQ_R__ imag, + const int count) +{ + for (int i = 0; i < count; ++i) { + c_magphase(mag + i, phase + i, real[i], imag[i]); + } +} + +template // S source, T target +void v_cartesian_interleaved_to_polar(T *const BQ_R__ mag, + T *const BQ_R__ phase, + const S *const BQ_R__ src, + const int count) +{ + for (int i = 0; i < count; ++i) { + c_magphase(mag + i, phase + i, src[i*2], src[i*2+1]); + } +} + +#ifdef HAVE_VDSP +template<> +inline void v_cartesian_to_polar(float *const BQ_R__ mag, + float *const BQ_R__ phase, + const float *const BQ_R__ real, + const float *const BQ_R__ imag, + const int count) +{ + DSPSplitComplex c; + c.realp = const_cast(real); + c.imagp = const_cast(imag); + vDSP_zvmags(&c, 1, phase, 1, count); // using phase as a temporary dest + vvsqrtf(mag, phase, &count); // using phase as the source + vvatan2f(phase, imag, real, &count); +} +template<> +inline void v_cartesian_to_polar(double *const BQ_R__ mag, + double *const BQ_R__ phase, + const double *const BQ_R__ real, + const double *const BQ_R__ imag, + const int count) +{ + // double precision, this is significantly faster than using vDSP_polar + DSPDoubleSplitComplex c; + c.realp = const_cast(real); + c.imagp = const_cast(imag); + vDSP_zvmagsD(&c, 1, phase, 1, count); // using phase as a temporary dest + vvsqrt(mag, phase, &count); // using phase as the source + vvatan2(phase, imag, real, &count); +} +#endif + +template +void v_cartesian_to_polar_interleaved_inplace(T *const BQ_R__ srcdst, + const int count) +{ + T mag, phase; + for (int i = 0; i < count * 2; i += 2) { + c_magphase(&mag, &phase, srcdst[i], srcdst[i+1]); + srcdst[i] = mag; + srcdst[i+1] = phase; + } +} + +} + +#endif + diff -r 112766f4c34b -r 5d0a2ebb4d17 bqvec/pommier/neon_mathfun.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bqvec/pommier/neon_mathfun.h Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,301 @@ +/* NEON implementation of sin, cos, exp and log + + Inspired by Intel Approximate Math library, and based on the + corresponding algorithms of the cephes math library +*/ + +/* Copyright (C) 2011 Julien Pommier + + This software is provided 'as-is', without any express or implied + warranty. In no event will the authors be held liable for any damages + arising from the use of this software. + + Permission is granted to anyone to use this software for any purpose, + including commercial applications, and to alter it and redistribute it + freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. + 2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + 3. This notice may not be removed or altered from any source distribution. + + (this is the zlib license) +*/ + +#include + +typedef float32x4_t v4sf; // vector of 4 float +typedef uint32x4_t v4su; // vector of 4 uint32 +typedef int32x4_t v4si; // vector of 4 uint32 + +#define c_inv_mant_mask ~0x7f800000u +#define c_cephes_SQRTHF 0.707106781186547524 +#define c_cephes_log_p0 7.0376836292E-2 +#define c_cephes_log_p1 - 1.1514610310E-1 +#define c_cephes_log_p2 1.1676998740E-1 +#define c_cephes_log_p3 - 1.2420140846E-1 +#define c_cephes_log_p4 + 1.4249322787E-1 +#define c_cephes_log_p5 - 1.6668057665E-1 +#define c_cephes_log_p6 + 2.0000714765E-1 +#define c_cephes_log_p7 - 2.4999993993E-1 +#define c_cephes_log_p8 + 3.3333331174E-1 +#define c_cephes_log_q1 -2.12194440e-4 +#define c_cephes_log_q2 0.693359375 + +/* natural logarithm computed for 4 simultaneous float + return NaN for x <= 0 +*/ +v4sf log_ps(v4sf x) { + v4sf one = vdupq_n_f32(1); + + x = vmaxq_f32(x, vdupq_n_f32(0)); /* force flush to zero on denormal values */ + v4su invalid_mask = vcleq_f32(x, vdupq_n_f32(0)); + + v4si ux = vreinterpretq_s32_f32(x); + + v4si emm0 = vshrq_n_s32(ux, 23); + + /* keep only the fractional part */ + ux = vandq_s32(ux, vdupq_n_s32(c_inv_mant_mask)); + ux = vorrq_s32(ux, vreinterpretq_s32_f32(vdupq_n_f32(0.5f))); + x = vreinterpretq_f32_s32(ux); + + emm0 = vsubq_s32(emm0, vdupq_n_s32(0x7f)); + v4sf e = vcvtq_f32_s32(emm0); + + e = vaddq_f32(e, one); + + /* part2: + if( x < SQRTHF ) { + e -= 1; + x = x + x - 1.0; + } else { x = x - 1.0; } + */ + v4su mask = vcltq_f32(x, vdupq_n_f32(c_cephes_SQRTHF)); + v4sf tmp = vreinterpretq_f32_u32(vandq_u32(vreinterpretq_u32_f32(x), mask)); + x = vsubq_f32(x, one); + e = vsubq_f32(e, vreinterpretq_f32_u32(vandq_u32(vreinterpretq_u32_f32(one), mask))); + x = vaddq_f32(x, tmp); + + v4sf z = vmulq_f32(x,x); + + v4sf y = vdupq_n_f32(c_cephes_log_p0); + y = vmulq_f32(y, x); + y = vaddq_f32(y, vdupq_n_f32(c_cephes_log_p1)); + y = vmulq_f32(y, x); + y = vaddq_f32(y, vdupq_n_f32(c_cephes_log_p2)); + y = vmulq_f32(y, x); + y = vaddq_f32(y, vdupq_n_f32(c_cephes_log_p3)); + y = vmulq_f32(y, x); + y = vaddq_f32(y, vdupq_n_f32(c_cephes_log_p4)); + y = vmulq_f32(y, x); + y = vaddq_f32(y, vdupq_n_f32(c_cephes_log_p5)); + y = vmulq_f32(y, x); + y = vaddq_f32(y, vdupq_n_f32(c_cephes_log_p6)); + y = vmulq_f32(y, x); + y = vaddq_f32(y, vdupq_n_f32(c_cephes_log_p7)); + y = vmulq_f32(y, x); + y = vaddq_f32(y, vdupq_n_f32(c_cephes_log_p8)); + y = vmulq_f32(y, x); + + y = vmulq_f32(y, z); + + + tmp = vmulq_f32(e, vdupq_n_f32(c_cephes_log_q1)); + y = vaddq_f32(y, tmp); + + + tmp = vmulq_f32(z, vdupq_n_f32(0.5f)); + y = vsubq_f32(y, tmp); + + tmp = vmulq_f32(e, vdupq_n_f32(c_cephes_log_q2)); + x = vaddq_f32(x, y); + x = vaddq_f32(x, tmp); + x = vreinterpretq_f32_u32(vorrq_u32(vreinterpretq_u32_f32(x), invalid_mask)); // negative arg will be NAN + return x; +} + +#define c_exp_hi 88.3762626647949f +#define c_exp_lo -88.3762626647949f + +#define c_cephes_LOG2EF 1.44269504088896341 +#define c_cephes_exp_C1 0.693359375 +#define c_cephes_exp_C2 -2.12194440e-4 + +#define c_cephes_exp_p0 1.9875691500E-4 +#define c_cephes_exp_p1 1.3981999507E-3 +#define c_cephes_exp_p2 8.3334519073E-3 +#define c_cephes_exp_p3 4.1665795894E-2 +#define c_cephes_exp_p4 1.6666665459E-1 +#define c_cephes_exp_p5 5.0000001201E-1 + +/* exp() computed for 4 float at once */ +v4sf exp_ps(v4sf x) { + v4sf tmp, fx; + + v4sf one = vdupq_n_f32(1); + x = vminq_f32(x, vdupq_n_f32(c_exp_hi)); + x = vmaxq_f32(x, vdupq_n_f32(c_exp_lo)); + + /* express exp(x) as exp(g + n*log(2)) */ + fx = vmlaq_f32(vdupq_n_f32(0.5f), x, vdupq_n_f32(c_cephes_LOG2EF)); + + /* perform a floorf */ + tmp = vcvtq_f32_s32(vcvtq_s32_f32(fx)); + + /* if greater, substract 1 */ + v4su mask = vcgtq_f32(tmp, fx); + mask = vandq_u32(mask, vreinterpretq_u32_f32(one)); + + + fx = vsubq_f32(tmp, vreinterpretq_f32_u32(mask)); + + tmp = vmulq_f32(fx, vdupq_n_f32(c_cephes_exp_C1)); + v4sf z = vmulq_f32(fx, vdupq_n_f32(c_cephes_exp_C2)); + x = vsubq_f32(x, tmp); + x = vsubq_f32(x, z); + + static const float32_t cephes_exp_p[6] = { c_cephes_exp_p0, c_cephes_exp_p1, c_cephes_exp_p2, c_cephes_exp_p3, c_cephes_exp_p4, c_cephes_exp_p5 }; + v4sf y = vld1q_dup_f32(cephes_exp_p+0); + v4sf c1 = vld1q_dup_f32(cephes_exp_p+1); + v4sf c2 = vld1q_dup_f32(cephes_exp_p+2); + v4sf c3 = vld1q_dup_f32(cephes_exp_p+3); + v4sf c4 = vld1q_dup_f32(cephes_exp_p+4); + v4sf c5 = vld1q_dup_f32(cephes_exp_p+5); + + y = vmulq_f32(y, x); + z = vmulq_f32(x,x); + y = vaddq_f32(y, c1); + y = vmulq_f32(y, x); + y = vaddq_f32(y, c2); + y = vmulq_f32(y, x); + y = vaddq_f32(y, c3); + y = vmulq_f32(y, x); + y = vaddq_f32(y, c4); + y = vmulq_f32(y, x); + y = vaddq_f32(y, c5); + + y = vmulq_f32(y, z); + y = vaddq_f32(y, x); + y = vaddq_f32(y, one); + + /* build 2^n */ + int32x4_t mm; + mm = vcvtq_s32_f32(fx); + mm = vaddq_s32(mm, vdupq_n_s32(0x7f)); + mm = vshlq_n_s32(mm, 23); + v4sf pow2n = vreinterpretq_f32_s32(mm); + + y = vmulq_f32(y, pow2n); + return y; +} + +#define c_minus_cephes_DP1 -0.78515625 +#define c_minus_cephes_DP2 -2.4187564849853515625e-4 +#define c_minus_cephes_DP3 -3.77489497744594108e-8 +#define c_sincof_p0 -1.9515295891E-4 +#define c_sincof_p1 8.3321608736E-3 +#define c_sincof_p2 -1.6666654611E-1 +#define c_coscof_p0 2.443315711809948E-005 +#define c_coscof_p1 -1.388731625493765E-003 +#define c_coscof_p2 4.166664568298827E-002 +#define c_cephes_FOPI 1.27323954473516 // 4 / M_PI + +/* evaluation of 4 sines & cosines at once. + + The code is the exact rewriting of the cephes sinf function. + Precision is excellent as long as x < 8192 (I did not bother to + take into account the special handling they have for greater values + -- it does not return garbage for arguments over 8192, though, but + the extra precision is missing). + + Note that it is such that sinf((float)M_PI) = 8.74e-8, which is the + surprising but correct result. + + Note also that when you compute sin(x), cos(x) is available at + almost no extra price so both sin_ps and cos_ps make use of + sincos_ps.. + */ +void sincos_ps(v4sf x, v4sf *ysin, v4sf *ycos) { // any x + v4sf xmm1, xmm2, xmm3, y; + + v4su emm2; + + v4su sign_mask_sin, sign_mask_cos; + sign_mask_sin = vcltq_f32(x, vdupq_n_f32(0)); + x = vabsq_f32(x); + + /* scale by 4/Pi */ + y = vmulq_f32(x, vdupq_n_f32(c_cephes_FOPI)); + + /* store the integer part of y in mm0 */ + emm2 = vcvtq_u32_f32(y); + /* j=(j+1) & (~1) (see the cephes sources) */ + emm2 = vaddq_u32(emm2, vdupq_n_u32(1)); + emm2 = vandq_u32(emm2, vdupq_n_u32(~1)); + y = vcvtq_f32_u32(emm2); + + /* get the polynom selection mask + there is one polynom for 0 <= x <= Pi/4 + and another one for Pi/4 + +/* yes I know, the top of this file is quite ugly */ + +#ifdef _MSC_VER /* visual c++ */ +# define ALIGN16_BEG __declspec(align(16)) +# define ALIGN16_END +#else /* gcc or icc */ +# define ALIGN16_BEG +# define ALIGN16_END __attribute__((aligned(16))) +#endif + +/* __m128 is ugly to write */ +typedef __m128 v4sf; // vector of 4 float (sse1) + +#ifdef USE_SSE2 +# include +typedef __m128i v4si; // vector of 4 int (sse2) +#else +typedef __m64 v2si; // vector of 2 int (mmx) +#endif + +/* declare some SSE constants -- why can't I figure a better way to do that? */ +#define _PS_CONST(Name, Val) \ + static const ALIGN16_BEG float _ps_##Name[4] ALIGN16_END = { Val, Val, Val, Val } +#define _PI32_CONST(Name, Val) \ + static const ALIGN16_BEG int _pi32_##Name[4] ALIGN16_END = { Val, Val, Val, Val } +#define _PS_CONST_TYPE(Name, Type, Val) \ + static const ALIGN16_BEG Type _ps_##Name[4] ALIGN16_END = { Val, Val, Val, Val } + +_PS_CONST(1 , 1.0f); +_PS_CONST(0p5, 0.5f); +/* the smallest non denormalized float number */ +_PS_CONST_TYPE(min_norm_pos, int, 0x00800000); +_PS_CONST_TYPE(mant_mask, int, 0x7f800000); +_PS_CONST_TYPE(inv_mant_mask, int, ~0x7f800000); + +_PS_CONST_TYPE(sign_mask, int, 0x80000000); +_PS_CONST_TYPE(inv_sign_mask, int, ~0x80000000); + +_PI32_CONST(1, 1); +_PI32_CONST(inv1, ~1); +_PI32_CONST(2, 2); +_PI32_CONST(4, 4); +_PI32_CONST(0x7f, 0x7f); + +_PS_CONST(cephes_SQRTHF, 0.707106781186547524); +_PS_CONST(cephes_log_p0, 7.0376836292E-2); +_PS_CONST(cephes_log_p1, - 1.1514610310E-1); +_PS_CONST(cephes_log_p2, 1.1676998740E-1); +_PS_CONST(cephes_log_p3, - 1.2420140846E-1); +_PS_CONST(cephes_log_p4, + 1.4249322787E-1); +_PS_CONST(cephes_log_p5, - 1.6668057665E-1); +_PS_CONST(cephes_log_p6, + 2.0000714765E-1); +_PS_CONST(cephes_log_p7, - 2.4999993993E-1); +_PS_CONST(cephes_log_p8, + 3.3333331174E-1); +_PS_CONST(cephes_log_q1, -2.12194440e-4); +_PS_CONST(cephes_log_q2, 0.693359375); + +#if defined (__MINGW32__) + +/* the ugly part below: many versions of gcc used to be completely buggy with respect to some intrinsics + The movehl_ps is fixed in mingw 3.4.5, but I found out that all the _mm_cmp* intrinsics were completely + broken on my mingw gcc 3.4.5 ... + + Note that the bug on _mm_cmp* does occur only at -O0 optimization level +*/ + +inline __m128 my_movehl_ps(__m128 a, const __m128 b) { + asm ( + "movhlps %2,%0\n\t" + : "=x" (a) + : "0" (a), "x"(b) + ); + return a; } +#warning "redefined _mm_movehl_ps (see gcc bug 21179)" +#define _mm_movehl_ps my_movehl_ps + +inline __m128 my_cmplt_ps(__m128 a, const __m128 b) { + asm ( + "cmpltps %2,%0\n\t" + : "=x" (a) + : "0" (a), "x"(b) + ); + return a; + } +inline __m128 my_cmpgt_ps(__m128 a, const __m128 b) { + asm ( + "cmpnleps %2,%0\n\t" + : "=x" (a) + : "0" (a), "x"(b) + ); + return a; +} +inline __m128 my_cmpeq_ps(__m128 a, const __m128 b) { + asm ( + "cmpeqps %2,%0\n\t" + : "=x" (a) + : "0" (a), "x"(b) + ); + return a; +} +#warning "redefined _mm_cmpxx_ps functions..." +#define _mm_cmplt_ps my_cmplt_ps +#define _mm_cmpgt_ps my_cmpgt_ps +#define _mm_cmpeq_ps my_cmpeq_ps +#endif + +#ifndef USE_SSE2 +typedef union xmm_mm_union { + __m128 xmm; + __m64 mm[2]; +} xmm_mm_union; + +#define COPY_XMM_TO_MM(xmm_, mm0_, mm1_) { \ + xmm_mm_union u; u.xmm = xmm_; \ + mm0_ = u.mm[0]; \ + mm1_ = u.mm[1]; \ +} + +#define COPY_MM_TO_XMM(mm0_, mm1_, xmm_) { \ + xmm_mm_union u; u.mm[0]=mm0_; u.mm[1]=mm1_; xmm_ = u.xmm; \ + } + +#endif // USE_SSE2 + +/* natural logarithm computed for 4 simultaneous float + return NaN for x <= 0 +*/ +v4sf log_ps(v4sf x) { +#ifdef USE_SSE2 + v4si emm0; +#else + v2si mm0, mm1; +#endif + v4sf one = *(v4sf*)_ps_1; + + v4sf invalid_mask = _mm_cmple_ps(x, _mm_setzero_ps()); + + x = _mm_max_ps(x, *(v4sf*)_ps_min_norm_pos); /* cut off denormalized stuff */ + +#ifndef USE_SSE2 + /* part 1: x = frexpf(x, &e); */ + COPY_XMM_TO_MM(x, mm0, mm1); + mm0 = _mm_srli_pi32(mm0, 23); + mm1 = _mm_srli_pi32(mm1, 23); +#else + emm0 = _mm_srli_epi32(_mm_castps_si128(x), 23); +#endif + /* keep only the fractional part */ + x = _mm_and_ps(x, *(v4sf*)_ps_inv_mant_mask); + x = _mm_or_ps(x, *(v4sf*)_ps_0p5); + +#ifndef USE_SSE2 + /* now e=mm0:mm1 contain the really base-2 exponent */ + mm0 = _mm_sub_pi32(mm0, *(v2si*)_pi32_0x7f); + mm1 = _mm_sub_pi32(mm1, *(v2si*)_pi32_0x7f); + v4sf e = _mm_cvtpi32x2_ps(mm0, mm1); + _mm_empty(); /* bye bye mmx */ +#else + emm0 = _mm_sub_epi32(emm0, *(v4si*)_pi32_0x7f); + v4sf e = _mm_cvtepi32_ps(emm0); +#endif + + e = _mm_add_ps(e, one); + + /* part2: + if( x < SQRTHF ) { + e -= 1; + x = x + x - 1.0; + } else { x = x - 1.0; } + */ + v4sf mask = _mm_cmplt_ps(x, *(v4sf*)_ps_cephes_SQRTHF); + v4sf tmp = _mm_and_ps(x, mask); + x = _mm_sub_ps(x, one); + e = _mm_sub_ps(e, _mm_and_ps(one, mask)); + x = _mm_add_ps(x, tmp); + + + v4sf z = _mm_mul_ps(x,x); + + v4sf y = *(v4sf*)_ps_cephes_log_p0; + y = _mm_mul_ps(y, x); + y = _mm_add_ps(y, *(v4sf*)_ps_cephes_log_p1); + y = _mm_mul_ps(y, x); + y = _mm_add_ps(y, *(v4sf*)_ps_cephes_log_p2); + y = _mm_mul_ps(y, x); + y = _mm_add_ps(y, *(v4sf*)_ps_cephes_log_p3); + y = _mm_mul_ps(y, x); + y = _mm_add_ps(y, *(v4sf*)_ps_cephes_log_p4); + y = _mm_mul_ps(y, x); + y = _mm_add_ps(y, *(v4sf*)_ps_cephes_log_p5); + y = _mm_mul_ps(y, x); + y = _mm_add_ps(y, *(v4sf*)_ps_cephes_log_p6); + y = _mm_mul_ps(y, x); + y = _mm_add_ps(y, *(v4sf*)_ps_cephes_log_p7); + y = _mm_mul_ps(y, x); + y = _mm_add_ps(y, *(v4sf*)_ps_cephes_log_p8); + y = _mm_mul_ps(y, x); + + y = _mm_mul_ps(y, z); + + + tmp = _mm_mul_ps(e, *(v4sf*)_ps_cephes_log_q1); + y = _mm_add_ps(y, tmp); + + + tmp = _mm_mul_ps(z, *(v4sf*)_ps_0p5); + y = _mm_sub_ps(y, tmp); + + tmp = _mm_mul_ps(e, *(v4sf*)_ps_cephes_log_q2); + x = _mm_add_ps(x, y); + x = _mm_add_ps(x, tmp); + x = _mm_or_ps(x, invalid_mask); // negative arg will be NAN + return x; +} + +_PS_CONST(exp_hi, 88.3762626647949f); +_PS_CONST(exp_lo, -88.3762626647949f); + +_PS_CONST(cephes_LOG2EF, 1.44269504088896341); +_PS_CONST(cephes_exp_C1, 0.693359375); +_PS_CONST(cephes_exp_C2, -2.12194440e-4); + +_PS_CONST(cephes_exp_p0, 1.9875691500E-4); +_PS_CONST(cephes_exp_p1, 1.3981999507E-3); +_PS_CONST(cephes_exp_p2, 8.3334519073E-3); +_PS_CONST(cephes_exp_p3, 4.1665795894E-2); +_PS_CONST(cephes_exp_p4, 1.6666665459E-1); +_PS_CONST(cephes_exp_p5, 5.0000001201E-1); + +v4sf exp_ps(v4sf x) { + v4sf tmp = _mm_setzero_ps(), fx; +#ifdef USE_SSE2 + v4si emm0; +#else + v2si mm0, mm1; +#endif + v4sf one = *(v4sf*)_ps_1; + + x = _mm_min_ps(x, *(v4sf*)_ps_exp_hi); + x = _mm_max_ps(x, *(v4sf*)_ps_exp_lo); + + /* express exp(x) as exp(g + n*log(2)) */ + fx = _mm_mul_ps(x, *(v4sf*)_ps_cephes_LOG2EF); + fx = _mm_add_ps(fx, *(v4sf*)_ps_0p5); + + /* how to perform a floorf with SSE: just below */ +#ifndef USE_SSE2 + /* step 1 : cast to int */ + tmp = _mm_movehl_ps(tmp, fx); + mm0 = _mm_cvttps_pi32(fx); + mm1 = _mm_cvttps_pi32(tmp); + /* step 2 : cast back to float */ + tmp = _mm_cvtpi32x2_ps(mm0, mm1); +#else + emm0 = _mm_cvttps_epi32(fx); + tmp = _mm_cvtepi32_ps(emm0); +#endif + /* if greater, substract 1 */ + v4sf mask = _mm_cmpgt_ps(tmp, fx); + mask = _mm_and_ps(mask, one); + fx = _mm_sub_ps(tmp, mask); + + tmp = _mm_mul_ps(fx, *(v4sf*)_ps_cephes_exp_C1); + v4sf z = _mm_mul_ps(fx, *(v4sf*)_ps_cephes_exp_C2); + x = _mm_sub_ps(x, tmp); + x = _mm_sub_ps(x, z); + + z = _mm_mul_ps(x,x); + + v4sf y = *(v4sf*)_ps_cephes_exp_p0; + y = _mm_mul_ps(y, x); + y = _mm_add_ps(y, *(v4sf*)_ps_cephes_exp_p1); + y = _mm_mul_ps(y, x); + y = _mm_add_ps(y, *(v4sf*)_ps_cephes_exp_p2); + y = _mm_mul_ps(y, x); + y = _mm_add_ps(y, *(v4sf*)_ps_cephes_exp_p3); + y = _mm_mul_ps(y, x); + y = _mm_add_ps(y, *(v4sf*)_ps_cephes_exp_p4); + y = _mm_mul_ps(y, x); + y = _mm_add_ps(y, *(v4sf*)_ps_cephes_exp_p5); + y = _mm_mul_ps(y, z); + y = _mm_add_ps(y, x); + y = _mm_add_ps(y, one); + + /* build 2^n */ +#ifndef USE_SSE2 + z = _mm_movehl_ps(z, fx); + mm0 = _mm_cvttps_pi32(fx); + mm1 = _mm_cvttps_pi32(z); + mm0 = _mm_add_pi32(mm0, *(v2si*)_pi32_0x7f); + mm1 = _mm_add_pi32(mm1, *(v2si*)_pi32_0x7f); + mm0 = _mm_slli_pi32(mm0, 23); + mm1 = _mm_slli_pi32(mm1, 23); + + v4sf pow2n; + COPY_MM_TO_XMM(mm0, mm1, pow2n); + _mm_empty(); +#else + emm0 = _mm_cvttps_epi32(fx); + emm0 = _mm_add_epi32(emm0, *(v4si*)_pi32_0x7f); + emm0 = _mm_slli_epi32(emm0, 23); + v4sf pow2n = _mm_castsi128_ps(emm0); +#endif + y = _mm_mul_ps(y, pow2n); + return y; +} + +_PS_CONST(minus_cephes_DP1, -0.78515625); +_PS_CONST(minus_cephes_DP2, -2.4187564849853515625e-4); +_PS_CONST(minus_cephes_DP3, -3.77489497744594108e-8); +_PS_CONST(sincof_p0, -1.9515295891E-4); +_PS_CONST(sincof_p1, 8.3321608736E-3); +_PS_CONST(sincof_p2, -1.6666654611E-1); +_PS_CONST(coscof_p0, 2.443315711809948E-005); +_PS_CONST(coscof_p1, -1.388731625493765E-003); +_PS_CONST(coscof_p2, 4.166664568298827E-002); +_PS_CONST(cephes_FOPI, 1.27323954473516); // 4 / M_PI + + +/* evaluation of 4 sines at onces, using only SSE1+MMX intrinsics so + it runs also on old athlons XPs and the pentium III of your grand + mother. + + The code is the exact rewriting of the cephes sinf function. + Precision is excellent as long as x < 8192 (I did not bother to + take into account the special handling they have for greater values + -- it does not return garbage for arguments over 8192, though, but + the extra precision is missing). + + Note that it is such that sinf((float)M_PI) = 8.74e-8, which is the + surprising but correct result. + + Performance is also surprisingly good, 1.33 times faster than the + macos vsinf SSE2 function, and 1.5 times faster than the + __vrs4_sinf of amd's ACML (which is only available in 64 bits). Not + too bad for an SSE1 function (with no special tuning) ! + However the latter libraries probably have a much better handling of NaN, + Inf, denormalized and other special arguments.. + + On my core 1 duo, the execution of this function takes approximately 95 cycles. + + From what I have observed on the experiments with Intel AMath lib, switching to an + SSE2 version would improve the perf by only 10%. + + Since it is based on SSE intrinsics, it has to be compiled at -O2 to + deliver full speed. +*/ +v4sf sin_ps(v4sf x) { // any x + v4sf xmm1, xmm2 = _mm_setzero_ps(), xmm3, sign_bit, y; + +#ifdef USE_SSE2 + v4si emm0, emm2; +#else + v2si mm0, mm1, mm2, mm3; +#endif + sign_bit = x; + /* take the absolute value */ + x = _mm_and_ps(x, *(v4sf*)_ps_inv_sign_mask); + /* extract the sign bit (upper one) */ + sign_bit = _mm_and_ps(sign_bit, *(v4sf*)_ps_sign_mask); + + /* scale by 4/Pi */ + y = _mm_mul_ps(x, *(v4sf*)_ps_cephes_FOPI); + + //printf("plop:"); print4(y); +#ifdef USE_SSE2 + /* store the integer part of y in mm0 */ + emm2 = _mm_cvttps_epi32(y); + /* j=(j+1) & (~1) (see the cephes sources) */ + emm2 = _mm_add_epi32(emm2, *(v4si*)_pi32_1); + emm2 = _mm_and_si128(emm2, *(v4si*)_pi32_inv1); + y = _mm_cvtepi32_ps(emm2); + /* get the swap sign flag */ + emm0 = _mm_and_si128(emm2, *(v4si*)_pi32_4); + emm0 = _mm_slli_epi32(emm0, 29); + /* get the polynom selection mask + there is one polynom for 0 <= x <= Pi/4 + and another one for Pi/4 +#endif + +#include +using std::cerr; +using std::endl; + +namespace breakfastquay { + +#ifdef HAVE_IPP + +template <> +float *allocate(size_t count) +{ + float *ptr = ippsMalloc_32f(count); + if (!ptr) throw (std::bad_alloc()); + return ptr; +} + +template <> +double *allocate(size_t count) +{ + double *ptr = ippsMalloc_64f(count); + if (!ptr) throw (std::bad_alloc()); + return ptr; +} + +template <> +void deallocate(float *ptr) +{ + if (ptr) ippsFree((void *)ptr); +} + +template <> +void deallocate(double *ptr) +{ + if (ptr) ippsFree((void *)ptr); +} + +#endif + +} + diff -r 112766f4c34b -r 5d0a2ebb4d17 bqvec/src/VectorOpsComplex.cpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bqvec/src/VectorOpsComplex.cpp Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,373 @@ +/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ + +/* + bqvec + + A small library for vector arithmetic and allocation in C++ using + raw C pointer arrays. + + Copyright 2007-2015 Particular Programs Ltd. + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, copy, + modify, merge, publish, distribute, sublicense, and/or sell copies + of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR + ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF + CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + Except as contained in this notice, the names of Chris Cannam and + Particular Programs Ltd shall not be used in advertising or + otherwise to promote the sale, use or other dealings in this + Software without prior written authorization. +*/ + +#include "bqvec/VectorOpsComplex.h" + +#include + +#ifdef __MSVC__ +#include +#define alloca _alloca +#endif + +#if defined USE_POMMIER_MATHFUN +#if defined __ARMEL__ +#include "pommier/neon_mathfun.h" +#else +#include "pommier/sse_mathfun.h" +#endif +#endif + +#ifdef __MSVC__ +#include +#define alloca _alloca +#endif + +namespace breakfastquay { + +#ifdef USE_APPROXIMATE_ATAN2 +float approximate_atan2f(float real, float imag) +{ + static const float pi = M_PI; + static const float pi2 = M_PI / 2; + + float atan; + + if (real == 0.f) { + + if (imag > 0.0f) atan = pi2; + else if (imag == 0.0f) atan = 0.0f; + else atan = -pi2; + + } else { + + float z = imag/real; + + if (fabsf(z) < 1.f) { + atan = z / (1.f + 0.28f * z * z); + if (real < 0.f) { + if (imag < 0.f) atan -= pi; + else atan += pi; + } + } else { + atan = pi2 - z / (z * z + 0.28f); + if (imag < 0.f) atan -= pi; + } + } +} +#endif + +#if defined USE_POMMIER_MATHFUN + +#ifdef __ARMEL__ +typedef union { + float f[4]; + int i[4]; + v4sf v; +} V4SF; +#else +typedef ALIGN16_BEG union { + float f[4]; + int i[4]; + v4sf v; +} ALIGN16_END V4SF; +#endif + +void +v_polar_to_cartesian_pommier(float *const BQ_R__ real, + float *const BQ_R__ imag, + const float *const BQ_R__ mag, + const float *const BQ_R__ phase, + const int count) +{ + int idx = 0, tidx = 0; + int i = 0; + + for (int i = 0; i + 4 < count; i += 4) { + + V4SF fmag, fphase, fre, fim; + + for (int j = 0; j < 3; ++j) { + fmag.f[j] = mag[idx]; + fphase.f[j] = phase[idx++]; + } + + sincos_ps(fphase.v, &fim.v, &fre.v); + + for (int j = 0; j < 3; ++j) { + real[tidx] = fre.f[j] * fmag.f[j]; + imag[tidx++] = fim.f[j] * fmag.f[j]; + } + } + + while (i < count) { + float re, im; + c_phasor(&re, &im, phase[i]); + real[tidx] = re * mag[i]; + imag[tidx++] = im * mag[i]; + ++i; + } +} + +void +v_polar_interleaved_to_cartesian_inplace_pommier(float *const BQ_R__ srcdst, + const int count) +{ + int i; + int idx = 0, tidx = 0; + + for (i = 0; i + 4 < count; i += 4) { + + V4SF fmag, fphase, fre, fim; + + for (int j = 0; j < 3; ++j) { + fmag.f[j] = srcdst[idx++]; + fphase.f[j] = srcdst[idx++]; + } + + sincos_ps(fphase.v, &fim.v, &fre.v); + + for (int j = 0; j < 3; ++j) { + srcdst[tidx++] = fre.f[j] * fmag.f[j]; + srcdst[tidx++] = fim.f[j] * fmag.f[j]; + } + } + + while (i < count) { + float real, imag; + float mag = srcdst[idx++]; + float phase = srcdst[idx++]; + c_phasor(&real, &imag, phase); + srcdst[tidx++] = real * mag; + srcdst[tidx++] = imag * mag; + ++i; + } +} + +void +v_polar_to_cartesian_interleaved_pommier(float *const BQ_R__ dst, + const float *const BQ_R__ mag, + const float *const BQ_R__ phase, + const int count) +{ + int i; + int idx = 0, tidx = 0; + + for (i = 0; i + 4 <= count; i += 4) { + + V4SF fmag, fphase, fre, fim; + + for (int j = 0; j < 3; ++j) { + fmag.f[j] = mag[idx]; + fphase.f[j] = phase[idx]; + ++idx; + } + + sincos_ps(fphase.v, &fim.v, &fre.v); + + for (int j = 0; j < 3; ++j) { + dst[tidx++] = fre.f[j] * fmag.f[j]; + dst[tidx++] = fim.f[j] * fmag.f[j]; + } + } + + while (i < count) { + float real, imag; + c_phasor(&real, &imag, phase[i]); + dst[tidx++] = real * mag[i]; + dst[tidx++] = imag * mag[i]; + ++i; + } +} + +#endif + +#ifndef NO_COMPLEX_TYPES + +#if defined HAVE_IPP + +void +v_polar_to_cartesian(bq_complex_t *const BQ_R__ dst, + const bq_complex_element_t *const BQ_R__ mag, + const bq_complex_element_t *const BQ_R__ phase, + const int count) +{ + if (sizeof(bq_complex_element_t) == sizeof(float)) { + ippsPolarToCart_32fc((const float *)mag, (const float *)phase, + (Ipp32fc *)dst, count); + } else { + ippsPolarToCart_64fc((const double *)mag, (const double *)phase, + (Ipp64fc *)dst, count); + } +} + +#elif defined HAVE_VDSP + +void +v_polar_to_cartesian(bq_complex_t *const BQ_R__ dst, + const bq_complex_element_t *const BQ_R__ mag, + const bq_complex_element_t *const BQ_R__ phase, + const int count) +{ + bq_complex_element_t *sc = (bq_complex_element_t *) + alloca(count * 2 * sizeof(bq_complex_element_t)); + + if (sizeof(bq_complex_element_t) == sizeof(float)) { + vvsincosf((float *)sc, (float *)(sc + count), (float *)phase, &count); + } else { + vvsincos((double *)sc, (double *)(sc + count), (double *)phase, &count); + } + + int sini = 0; + int cosi = count; + + for (int i = 0; i < count; ++i) { + dst[i].re = mag[i] * sc[cosi++]; + dst[i].im = mag[i] * sc[sini++]; + } +} + +#else + +void +v_polar_to_cartesian(bq_complex_t *const BQ_R__ dst, + const bq_complex_element_t *const BQ_R__ mag, + const bq_complex_element_t *const BQ_R__ phase, + const int count) +{ + for (int i = 0; i < count; ++i) { + dst[i] = c_phasor(phase[i]); + } + for (int i = 0; i < count; ++i) { + dst[i].re *= mag[i]; + dst[i].im *= mag[i]; + } +} + +#endif + +#if defined USE_POMMIER_MATHFUN + +//!!! further tests reqd. This is only single precision but it seems +//!!! to be much faster than normal math library sincos. The comments +//!!! note that precision suffers for high arguments to sincos though, +//!!! and that is probably a common case for us + +void +v_polar_interleaved_to_cartesian(bq_complex_t *const BQ_R__ dst, + const bq_complex_element_t *const BQ_R__ src, + const int count) +{ + int idx = 0, tidx = 0; + + for (int i = 0; i < count; i += 4) { + + V4SF fmag, fphase, fre, fim; + + for (int j = 0; j < 3; ++j) { + fmag.f[j] = src[idx++]; + fphase.f[j] = src[idx++]; + } + + sincos_ps(fphase.v, &fim.v, &fre.v); + + for (int j = 0; j < 3; ++j) { + dst[tidx].re = fre.f[j] * fmag.f[j]; + dst[tidx++].im = fim.f[j] * fmag.f[j]; + } + } +} + +#elif (defined HAVE_IPP || defined HAVE_VDSP) + +// with a vector library, it should be faster to deinterleave and call +// the basic fn + +void +v_polar_interleaved_to_cartesian(bq_complex_t *const BQ_R__ dst, + const bq_complex_element_t *const BQ_R__ src, + const int count) +{ + bq_complex_element_t *mag = (bq_complex_element_t *) + alloca(count * sizeof(bq_complex_element_t)); + bq_complex_element_t *phase = (bq_complex_element_t *) + alloca(count * sizeof(bq_complex_element_t)); + bq_complex_element_t *magphase[] = { mag, phase }; + + v_deinterleave(magphase, src, 2, count); + v_polar_to_cartesian(dst, mag, phase, count); +} + +#else + +// without a vector library, better avoid the deinterleave step + +void +v_polar_interleaved_to_cartesian(bq_complex_t *const BQ_R__ dst, + const bq_complex_element_t *const BQ_R__ src, + const int count) +{ + bq_complex_element_t mag, phase; + int idx = 0; + for (int i = 0; i < count; ++i) { + mag = src[idx++]; + phase = src[idx++]; + dst[i] = c_phasor(phase); + dst[i].re *= mag; + dst[i].im *= mag; + } +} + +#endif + +void +v_polar_interleaved_to_cartesian_inplace(bq_complex_element_t *const BQ_R__ srcdst, + const int count) +{ + // Not ideal + bq_complex_element_t mag, phase; + int ii = 0, io = 0; + for (int i = 0; i < count; ++i) { + mag = srcdst[ii++]; + phase = srcdst[ii++]; + bq_complex_t p = c_phasor(phase); + srcdst[io++] = mag * p.re; + srcdst[io++] = mag * p.im; + } +} + +#endif + +} diff -r 112766f4c34b -r 5d0a2ebb4d17 bqvec/test/TestVectorOps.cpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bqvec/test/TestVectorOps.cpp Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,254 @@ +/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ + +#include "VectorOpsComplex.h" + +#include +#include + +#include + +using namespace std; + +namespace breakfastquay { + +namespace Test { + +#ifdef _WIN32 +#define drand48() (-1+2*((float)rand())/RAND_MAX) +#endif + +bool +testMultiply() +{ + cerr << "testVectorOps: testing v_multiply complex" << endl; + + const int N = 1024; + turbot_complex_sample_t target[N]; + turbot_complex_sample_t src1[N]; + turbot_complex_sample_t src2[N]; + + for (int i = 0; i < N; ++i) { + src1[i].re = drand48(); + src1[i].im = drand48(); + src2[i].re = drand48(); + src2[i].im = drand48(); + } + + turbot_sample_t mean, first, last, total = 0; + for (int i = 0; i < N; ++i) { + turbot_complex_sample_t result; + c_multiply(result, src1[i], src2[i]); + if (i == 0) first = result.re; + if (i == N-1) last = result.im; + total += result.re; + total += result.im; + } + mean = total / (N*2); + cerr << "Naive method: mean = " << mean << ", first = " << first + << ", last = " << last << endl; + + v_multiply(target, src1, src2, N); + total = 0; + + for (int i = 0; i < N; ++i) { + if (i == 0) first = target[i].re; + if (i == N-1) last = target[i].im; + total += target[i].re; + total += target[i].im; + } + mean = total / (N*2); + cerr << "v_multiply: mean = " << mean << ", first = " << first + << ", last = " << last << endl; + + int iterations = 50000; + cerr << "Iterations: " << iterations << endl; + + cerr << "CLOCKS_PER_SEC = " << CLOCKS_PER_SEC << endl; + float divisor = float(CLOCKS_PER_SEC) / 1000.f; + + clock_t start = clock(); + + for (int j = 0; j < iterations; ++j) { + for (int i = 0; i < N; ++i) { + c_multiply(target[i], src1[i], src2[i]); + } + } + + clock_t end = clock(); + + cerr << "Time for naive method: " << float(end - start)/divisor << endl; + + start = clock(); + + for (int j = 0; j < iterations; ++j) { + v_multiply(target, src1, src2, N); + } + + end = clock(); + + cerr << "Time for v_multiply: " << float(end - start)/divisor << endl; + + return true; +} + +bool +testPolarToCart() +{ + cerr << "testVectorOps: testing v_polar_to_cartesian" << endl; + + const int N = 1024; + turbot_complex_sample_t target[N]; + turbot_sample_t mag[N]; + turbot_sample_t phase[N]; + + for (int i = 0; i < N; ++i) { + mag[i] = drand48(); + phase[i] = (drand48() * M_PI * 2) - M_PI; + } + + turbot_sample_t mean, first, last, total = 0; + for (int i = 0; i < N; ++i) { + turbot_sample_t real = mag[i] * cos(phase[i]); + turbot_sample_t imag = mag[i] * sin(phase[i]); + if (i == 0) first = real; + if (i == N-1) last = imag; + total += real; + total += imag; + } + mean = total / (N*2); + cerr << "Naive method: mean = " << mean << ", first = " << first + << ", last = " << last << endl; + + v_polar_to_cartesian(target, mag, phase, N); + + total = 0; + + for (int i = 0; i < N; ++i) { + if (i == 0) first = target[i].re; + if (i == N-1) last = target[i].im; + total += target[i].re; + total += target[i].im; + } + mean = total / (N*2); + cerr << "v_polar_to_cartesian: mean = " << mean << ", first = " << first + << ", last = " << last << endl; + + int iterations = 10000; + cerr << "Iterations: " << iterations << endl; + + cerr << "CLOCKS_PER_SEC = " << CLOCKS_PER_SEC << endl; + float divisor = float(CLOCKS_PER_SEC) / 1000.f; + + clock_t start = clock(); + + for (int j = 0; j < iterations; ++j) { + for (int i = 0; i < N; ++i) { + target[i].re = mag[i] * cos(phase[i]); + target[i].im = mag[i] * sin(phase[i]); + } + } + + clock_t end = clock(); + + cerr << "Time for naive method: " << float(end - start)/divisor << endl; + + start = clock(); + + for (int j = 0; j < iterations; ++j) { + v_polar_to_cartesian(target, mag, phase, N); + } + + end = clock(); + + cerr << "Time for v_polar_to_cartesian: " << float(end - start)/divisor << endl; + + return true; +} + +bool +testPolarToCartInterleaved() +{ + cerr << "testVectorOps: testing v_polar_interleaved_to_cartesian" << endl; + + const int N = 1024; + turbot_complex_sample_t target[N]; + turbot_sample_t source[N*2]; + + for (int i = 0; i < N; ++i) { + source[i*2] = drand48(); + source[i*2+1] = (drand48() * M_PI * 2) - M_PI; + } + + turbot_sample_t mean, first, last, total = 0; + for (int i = 0; i < N; ++i) { + turbot_sample_t real = source[i*2] * cos(source[i*2+1]); + turbot_sample_t imag = source[i*2] * sin(source[i*2+1]); + if (i == 0) first = real; + if (i == N-1) last = imag; + total += real; + total += imag; + } + mean = total / (N*2); + cerr << "Naive method: mean = " << mean << ", first = " << first + << ", last = " << last << endl; + + v_polar_interleaved_to_cartesian(target, source, N); + + total = 0; + + for (int i = 0; i < N; ++i) { + if (i == 0) first = target[i].re; + if (i == N-1) last = target[i].im; + total += target[i].re; + total += target[i].im; + } + mean = total / (N*2); + cerr << "v_polar_interleaved_to_cartesian: mean = " << mean << ", first = " << first + << ", last = " << last << endl; + + int iterations = 10000; + cerr << "Iterations: " << iterations << endl; + + cerr << "CLOCKS_PER_SEC = " << CLOCKS_PER_SEC << endl; + float divisor = float(CLOCKS_PER_SEC) / 1000.f; + + clock_t start = clock(); + + for (int j = 0; j < iterations; ++j) { + for (int i = 0; i < N; ++i) { + target[i].re = source[i*2] * cos(source[i*2+1]); + target[i].im = source[i*2] * sin(source[i*2+1]); + } + } + + clock_t end = clock(); + + cerr << "Time for naive method: " << float(end - start)/divisor << endl; + + start = clock(); + + for (int j = 0; j < iterations; ++j) { + v_polar_interleaved_to_cartesian(target, source, N); + } + + end = clock(); + + cerr << "Time for v_polar_interleaved_to_cartesian: " << float(end - start)/divisor << endl; + + return true; +} + +bool +testVectorOps() +{ + if (!testMultiply()) return false; + if (!testPolarToCart()) return false; + if (!testPolarToCartInterleaved()) return false; + + return true; +} + +} + +} + diff -r 112766f4c34b -r 5d0a2ebb4d17 bqvec/test/TestVectorOps.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bqvec/test/TestVectorOps.h Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,12 @@ +/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ + +namespace breakfastquay { + +namespace Test { + +bool testVectorOps(); + +} + +} + diff -r 112766f4c34b -r 5d0a2ebb4d17 constant-q-cpp/.hgignore --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/constant-q-cpp/.hgignore Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,12 @@ +syntax: glob +*~ +*.o +*.so +*.a +*.dylib +*.dll +*.class +doc/ + +syntax: re +^test/Test[^.]*$ diff -r 112766f4c34b -r 5d0a2ebb4d17 constant-q-cpp/.hgsub --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/constant-q-cpp/.hgsub Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,1 @@ +misc/matlab = https://code.soundsoftware.ac.uk/hg/constant-q-toolbox diff -r 112766f4c34b -r 5d0a2ebb4d17 constant-q-cpp/.hgsubstate --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/constant-q-cpp/.hgsubstate Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,1 @@ +2b03ca77abcc91140dbb37827f06034769c53547 misc/matlab diff -r 112766f4c34b -r 5d0a2ebb4d17 constant-q-cpp/.hgtags --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/constant-q-cpp/.hgtags Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,4 @@ +361b4f8b7b2dbce9aebec3ff577f5c68f6fbb3ae v1.0 +361b4f8b7b2dbce9aebec3ff577f5c68f6fbb3ae v1.0 +5a4ece568299eba6ca7e54b283de5e98b6a3526b v1.0 +50a61e18af29ab383f210c1f2099b4dc49f1495f v1.1 diff -r 112766f4c34b -r 5d0a2ebb4d17 constant-q-cpp/CITATION --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/constant-q-cpp/CITATION Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,7 @@ + @inproceedings{christian2010a, + author = {Christian Schörkhuber and Anssi Klapuri}, + title = {Constant-Q transform toolbox for music processing}, + booktitle = {Proceedings of the 7th Sound and Music Computing Conference, Barcelona, Spain}, + month = {July}, + year = {2010} +} diff -r 112766f4c34b -r 5d0a2ebb4d17 constant-q-cpp/COPYING --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/constant-q-cpp/COPYING Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,65 @@ + +This library is distributed under the following licence: + + Copyright (c) 2013-2014 Queen Mary, University of London + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, copy, + modify, merge, publish, distribute, sublicense, and/or sell copies + of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY + CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF + CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + Except as contained in this notice, the names of the Centre for + Digital Music; Queen Mary, University of London; and Chris Cannam + shall not be used in advertising or otherwise to promote the sale, + use or other dealings in this Software without prior written + authorization. + +The code in src/ext/kissfft is distributed under the following licence: + + Copyright (c) 2003-2010 Mark Borgerding + + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + + * Neither the author nor the names of any contributors may be used + to endorse or promote products derived from this software + without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS + BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED + TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR + TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF + THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + SUCH DAMAGE. diff -r 112766f4c34b -r 5d0a2ebb4d17 constant-q-cpp/Doxyfile --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/constant-q-cpp/Doxyfile Fri Jun 24 14:47:45 2016 +0100 @@ -0,0 +1,2310 @@ +# Doxyfile 1.8.7 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Constant-Q Library" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = cq src vamp + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /