//////////////////////////////////////////////////////////////////////////////// /// @brief variant class for two-dimensional matrices /// /// @file /// /// DISCLAIMER /// /// Copyright 2004-2012 triagens GmbH, Cologne, Germany /// /// Licensed under the Apache License, Version 2.0 (the "License"); /// you may not use this file except in compliance with the License. /// You may obtain a copy of the License at /// /// http://www.apache.org/licenses/LICENSE-2.0 /// /// Unless required by applicable law or agreed to in writing, software /// distributed under the License is distributed on an "AS IS" BASIS, /// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. /// See the License for the specific language governing permissions and /// limitations under the License. /// /// Copyright holder is triAGENS GmbH, Cologne, Germany /// /// @author Dr. Frank Celler /// @author Achim Brandt /// @author Copyright 2009-2012, triAGENS GmbH, Cologne, Germany //////////////////////////////////////////////////////////////////////////////// #ifndef TRIAGENS_VARIANT_VARIANT_MATRIX2_H #define TRIAGENS_VARIANT_VARIANT_MATRIX2_H 1 #include "Variant/VariantObject.h" namespace triagens { namespace basics { // ----------------------------------------------------------------------------- // --SECTION-- class VariantMatrix2 // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup Variants /// @{ //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// /// @brief variant class for two-dimensional matrices //////////////////////////////////////////////////////////////////////////////// class VariantMatrix2 : public VariantObject { //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- static public constants // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup Variants /// @{ //////////////////////////////////////////////////////////////////////////////// public: //////////////////////////////////////////////////////////////////////////////// /// @brief type of VariantObject //////////////////////////////////////////////////////////////////////////////// static ObjectType const TYPE = VARIANT_MATRIX2; //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- constructors and destructors // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup Variants /// @{ //////////////////////////////////////////////////////////////////////////////// public: //////////////////////////////////////////////////////////////////////////////// /// @brief constructs a new matrix2 //////////////////////////////////////////////////////////////////////////////// VariantMatrix2 (); //////////////////////////////////////////////////////////////////////////////// /// @brief destructs a new matrix2 //////////////////////////////////////////////////////////////////////////////// ~VariantMatrix2 (); //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- VariantObject methods // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup Variants /// @{ //////////////////////////////////////////////////////////////////////////////// public: //////////////////////////////////////////////////////////////////////////////// /// {@inheritDoc} //////////////////////////////////////////////////////////////////////////////// ObjectType type () const; //////////////////////////////////////////////////////////////////////////////// /// {@inheritDoc} //////////////////////////////////////////////////////////////////////////////// VariantObject* clone () const; //////////////////////////////////////////////////////////////////////////////// /// {@inheritDoc} //////////////////////////////////////////////////////////////////////////////// void print (StringBuffer&, size_t indent) const; //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- public methods // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup Variants /// @{ //////////////////////////////////////////////////////////////////////////////// public: //////////////////////////////////////////////////////////////////////////////// /// @brief returns the dimensions //////////////////////////////////////////////////////////////////////////////// vector const& getDimension (size_t n) const; //////////////////////////////////////////////////////////////////////////////// /// @brief returns the values //////////////////////////////////////////////////////////////////////////////// vector< vector > const& getValues () const; //////////////////////////////////////////////////////////////////////////////// /// @brief returns the value at a given position //////////////////////////////////////////////////////////////////////////////// VariantObject* getValue (size_t x, size_t y) const; //////////////////////////////////////////////////////////////////////////////// /// @brief set a value //////////////////////////////////////////////////////////////////////////////// void setValue (size_t x, size_t y, VariantObject*); //////////////////////////////////////////////////////////////////////////////// /// @brief adds a dimension element //////////////////////////////////////////////////////////////////////////////// size_t addDimension (size_t n, string const& name); //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- private variables // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup Variants /// @{ //////////////////////////////////////////////////////////////////////////////// private: //////////////////////////////////////////////////////////////////////////////// /// @brief dimensions //////////////////////////////////////////////////////////////////////////////// vector _dimensions[2]; //////////////////////////////////////////////////////////////////////////////// /// @brief matrix //////////////////////////////////////////////////////////////////////////////// vector< vector > _values; }; } } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// #endif // Local Variables: // mode: outline-minor // outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @\\}\\)" // End: