/*****************************************************************************
 *  
 *   This file is part of the Utopia Documents application.
 *       Copyright (c) 2008-2014 Lost Island Labs
 *   
 *   Utopia Documents is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU GENERAL PUBLIC LICENSE VERSION 3 as
 *   published by the Free Software Foundation.
 *   
 *   Utopia Documents 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.
 *   
 *   In addition, as a special exception, the copyright holders give
 *   permission to link the code of portions of this program with the OpenSSL
 *   library under certain conditions as described in each individual source
 *   file, and distribute linked combinations including the two.
 *   
 *   You must obey the GNU General Public License in all respects for all of
 *   the code used other than OpenSSL. If you modify file(s) with this
 *   exception, you may extend this exception to your version of the file(s),
 *   but you are not obligated to do so. If you do not wish to do so, delete
 *   this exception statement from your version.
 *   
 *   You should have received a copy of the GNU General Public License
 *   along with Utopia Documents. If not, see <http://www.gnu.org/licenses/>
 *  
 *****************************************************************************/

#ifndef GTL_TRIPLE_INCL_
#define GTL_TRIPLE_INCL_

#include <gtl/config.h>

namespace gtl
{

    /**
     *  \class triple
     *  \brief Encapsulates a triple of values.
     *
     *  Analogue of the stl::pair class for three values.
     */
    template< typename First, typename Second, typename Third >
    class triple
    {
    public:
        /** Default constructor */
        triple()
            : first(), second(), third()
            {}

        /** Valued constructor, setting \a first, \a second and \a third to the values given. */
        triple(First & first, Second & second, Third & third)
            {
                this->first = first;
                this->second = second;
                this->third = third;
            }

        /* Members */
        First first;
        Second second;
        Third third;

    }; /* class triple */

    /**
     *  \brief Convenience function for creating triples.
     */
    template< typename First, typename Second, typename Third >
    triple< First, Second, Third > make_triple(First & first, Second & second, Third & third)
    {
        return triple< First, Second, Third >(first, second, third);
    }

} /* namespace gtl */

#endif /* GTL_TRIPLE_INCL_ */
