dims.h (2014-04-30 15:38:09 -0400, (build fd32605))

Go to the documentation of this file.

//-----------------------------------------------------------------------//
//   Copyright (c) AccelerEyes LLC. All rights reserved.                 //
//   See http://www.accelereyes.com/eula for details.                    //
//   This software is distributed WITHOUT ANY WARRANTY; without even     //
//   the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
//   PURPOSE.  See the above copyright notices for more information.     //
//-----------------------------------------------------------------------//

#pragma once

#include <iostream>
#include "defines.h"

namespace af {
class AFAPI dim4
{
    public:
        dim4();
        dim4(unsigned x, unsigned y=1, unsigned z=1, unsigned w=1);
        // \p dims is assumed to be owned by caller and values are copied into an internal array
        dim4(unsigned ndims, const unsigned *dims);
        dim4(const dim4&);

        unsigned elements() const;

        unsigned rest(unsigned i) const;


        unsigned numdims() const;

        const unsigned *dims() const;

        bool isempty()   const  { return elements() == 0; }

        bool isscalar()  const  { return elements() == 1; }

        bool isvector()  const  { return numdims() == 2 && (m_dims[0] == 1 || m_dims[1] == 1); }
        bool iscolumn()  const  { return numdims() == 2 && m_dims[1] == 1; }

        bool isrow()     const  { return numdims() == 2 && m_dims[0] == 1; }

        unsigned& operator[](unsigned);

        unsigned operator[](unsigned) const;

        bool operator==(const dim4&) const;

        bool operator!=(const dim4&) const;

        dim4& operator=(const dim4&);

        AFAPI friend std::ostream& operator<<(std::ostream&, const dim4&);

    private:
        unsigned m_dims[4];
};
};