Initial Commit

include/fennec/containers/array.h

@@ -0,0 +1,137 @@
+// =====================================================================================================================
+//  fennec, a free and open source game engine
+//  Copyright © 2025  Medusa Slockbower
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+// =====================================================================================================================
+
+///
+/// \file array.h
+/// \brief fennec::array definition & implementation
+///
+///
+/// \details
+/// \author Medusa Slockbower
+///
+/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+///
+///
+
+
+#ifndef FENNEC_CONTAINERS_ARRAY_H
+#define FENNEC_CONTAINERS_ARRAY_H
+
+#include <fennec/lang/types.h>
+
+#include <cassert>
+
+namespace fennec
+{
+
+///
+///
+/// \brief wrapper for fixed size arrays
+///
+/// \details
+/// \tparam ValueT value type
+/// \tparam ElemV number of elements
+///
+///
+template<typename ValueT, size_t ElemV>
+struct array
+{
+	///
+	/// \brief backing c-style array handle
+	ValueT elements[ElemV];
+
+	/// \name Element Access
+	/// @{
+
+	///
+	/// \copydetails array::at(size_t) const
+	constexpr ValueT& at(size_t i) { static_assert(i < ElemV); assert(i < ElemV); return elements[i]; }
+
+	///
+	/// \brief access specified element, **with bounds checking**
+	/// \details Returns a reference to the element at \c i
+	/// \param i index of the element to return
+	/// \return reference to the requested element
+	///
+	/// \par Time-Complexity
+	/// Constant
+	///
+	/// \par Space-Complexity
+	/// Constant
+	constexpr const ValueT& at(size_t i) const { static_assert(i < ElemV); assert(i < ElemV); return elements[i]; }
+
+
+
+	///
+	/// \copydetails array::operator[](size_t) const
+	constexpr ValueT& operator[](size_t i) { return elements[i]; }
+
+	///
+	/// \brief access specified element
+	/// \details Returns a reference to the element at \c i
+	/// \param i index of the element to return
+	/// \return reference to the requested element
+	///
+	/// \par Time-Complexity
+	/// Constant
+	///
+	/// \par Space-Complexity
+	/// Constant
+	constexpr const ValueT& operator[](size_t i) const { return elements[i]; }
+
+	/// @}
+
+
+
+	/// \name Capacity
+	/// @{
+
+	///
+	/// \brief returns the number of elements in the array
+	/// \returns the number of elements in the array
+	[[nodiscard]] constexpr size_t size() const { return ElemV; }
+
+	///
+	/// \brief returns **true** when the array is empty
+	/// \return \f$ElemV == 0\f$
+	[[nodiscard]] constexpr bool_t empty() const { return ElemV == 0; }
+
+	/// @}
+
+
+
+	/// \name Comparison Operators
+	/// @{
+
+	///
+	/// \brief
+	friend constexpr bool_t operator==(const array& lhs, const array& rhs)
+		{ return [lhs, rhs]<size_t...i>(index_sequence<i...>) -> bool_t // Lambda Declaration, Creates Indices at Compile Time
+		{ return ((lhs[i] == rhs[i]) && ...); }(make_index_sequence<ElemV>{}); } // Lambda Implementation,
+
+	friend constexpr bool_t operator!=(const array& lhs, const array& rhs)
+		{ return [lhs, rhs]<size_t...i>(index_sequence<i...>) -> bool_t
+		{ return ((lhs[i] != rhs[i]) || ...); }(make_index_sequence<ElemV>{}); }
+
+	/// @}
+
+};
+
+}
+
+#endif // FENNEC_CONTAINERS_ARRAY_H