array_span.hpp

00001 /*******************************************************************************
00002 * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
00003 *
00004 * Permission is hereby granted, free of charge, to any person obtaining a
00005 * copy of this software and associated documentation files (the "Software"),
00006 * to deal in the Software without restriction, including without limitation
00007 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008 * and/or sell copies of the Software, and to permit persons to whom the
00009 * Software is furnished to do so, subject to the following conditions:
00010 *
00011 * The above copyright notice and this permission notice shall be included
00012 * in all copies or substantial portions of the Software.
00013 *
00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020 * OTHER DEALINGS IN THE SOFTWARE.
00021 *
00022 * Except as contained in this notice, the name of Maxim Integrated
00023 * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024 * Products, Inc. Branding Policy.
00025 *
00026 * The mere transfer of this software does not imply any licenses
00027 * of trade secrets, proprietary technology, copyrights, patents,
00028 * trademarks, maskwork rights, or any other form of intellectual
00029 * property whatsoever. Maxim Integrated Products, Inc. retains all
00030 * ownership rights.
00031 *******************************************************************************/
00032 
00033 #ifndef MaximInterface_array_span
00034 #define MaximInterface_array_span
00035 
00036 #include "array.hpp"
00037 #include "span.hpp"
00038 #include "type_traits.hpp"
00039 
00040 namespace MaximInterface {
00041 
00042 /// @brief
00043 /// Defines a standard set of types for data fields that are represented as a
00044 /// fixed-size array of elements.
00045 /// @tparam T A const qualifier is not allowed.
00046 template <typename T, size_t N> struct array_span {
00047   typedef typename remove_volatile<T>::type element;
00048   static const size_t size = N;
00049   
00050   typedef MaximInterface::array<element, N> array;
00051   typedef MaximInterface::span<const T, N> const_span;
00052   typedef MaximInterface::span<T, N> span;
00053   
00054 private:
00055   array_span(); // deleted
00056 };
00057 
00058 // Specialization for "const T" is not defined.
00059 template <typename T, size_t N> struct array_span<const T, N>;
00060 
00061 }
00062 
00063 #endif