vctDynamicNArrayOwner.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*

  Author(s):    Daniel Li
  Created on:   2006-06-27

  (C) Copyright 2006-2007 Johns Hopkins University (JHU), All Rights
  Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/

#pragma once
#ifndef _vctDynamicNArrayOwner_h
#define _vctDynamicNArrayOwner_h

#include <cisstVector/vctForwardDeclarations.h>

template <class _elementType, vct::size_type _dimension>
class vctDynamicNArrayOwner
{
public:
    /* define most types from vctContainerTraits and vctNArrayTraits */
    VCT_CONTAINER_TRAITS_TYPEDEFS(_elementType);
    VCT_NARRAY_TRAITS_TYPEDEFS(_dimension);

    enum {DIMENSION = _dimension};

    typedef vctDynamicNArrayOwner<_elementType, _dimension> ThisType;

    /* iterators are container specific */
    typedef vctVarStrideNArrayIterator<ThisType, true> iterator;
    typedef vctVarStrideNArrayConstIterator<ThisType, true> const_iterator;
    typedef vctVarStrideNArrayIterator<ThisType, false> reverse_iterator;
    typedef vctVarStrideNArrayConstIterator<ThisType, false> const_reverse_iterator;


    vctDynamicNArrayOwner():
        SizesMember(0),
        StridesMember(0),
        Data(0)
    {}

    vctDynamicNArrayOwner(const nsize_type & sizes)
        : SizesMember(0)
        , StridesMember(0)
        , Data(0)
    {
        SetSize(sizes);
    }

    ~vctDynamicNArrayOwner()
    {
        Disown();
    }

    dimension_type dimension(void) const
    {
        return DIMENSION;
    }

    const nsize_type & sizes(void) const
    {
        return SizesMember;
    }

    size_type size(dimension_type dimension) const
    {
        if (dimension < DIMENSION)
            return SizesMember[dimension];
        else
            return 1;
    }

    size_type size(void) const
    {
        if (DIMENSION == 0)
            return 0;
        else
            return SizesMember.ProductOfElements();
    }

    const nstride_type & strides(void) const
    {
        return StridesMember;
    }

    stride_type stride(dimension_type dimension) const
    {
        if (dimension < DIMENSION)
            return StridesMember[dimension];
        else
            return 1;
    }

    pointer Pointer(void)
    {
        return Data;
    }

    pointer Pointer(const nsize_type & indices)
    {
        vctFixedSizeConstVectorRef<stride_type, DIMENSION, 1>
            indicesRef(reinterpret_cast<stride_type *>(const_cast<size_type *>(indices.Pointer())));
        return (Data + StridesMember.DotProduct(indicesRef));
    }

    const_pointer Pointer(void) const
    {
        return Data;
    }

    const_pointer Pointer(const nsize_type & indices) const
    {
        vctFixedSizeConstVectorRef<stride_type, DIMENSION, 1>
            indicesRef(reinterpret_cast<stride_type *>(const_cast<size_type *>(indices.Pointer())));
        return (Data + StridesMember.DotProduct(indicesRef));
    }

    iterator begin(void)
    {
        return iterator(this, 0);
    }

    iterator end(void)
    {
        return iterator(this, 0) + size();
    }

    const_iterator begin(void) const
    {
        return const_iterator(this, 0);
    }

    const_iterator end(void) const
    {
        return const_iterator(this, 0) + size();
    }

    reverse_iterator rbegin(void)
    {
        size_type endIndex = size() - 1;
        return reverse_iterator(this, endIndex);
    }

    reverse_iterator rend(void)
    {
        return reverse_iterator(this, 0) + 1;
    }

    const_reverse_iterator rbegin(void) const
    {
        size_type endIndex = size() - 1;
        return const_reverse_iterator(this, endIndex);
    }

    const_reverse_iterator rend(void) const
    {
        return const_reverse_iterator(this, 0) + 1;
    }

    bool IsCompact(void) const {
        return true;
    }

    void SetSize(const nsize_type & sizes)
    {
        if (SizesMember.Equal(sizes)) return;
        Disown();
        const size_type totalSize = sizes.ProductOfElements();
        Own(sizes, (totalSize == 0) ? 0 : new value_type[totalSize]);
    }

    value_type * Release(void)
    {
        value_type* oldData = Data;
        Data = 0;
        SizesMember.SetAll(0);
        UpdateStrides();
        return oldData;
    }

    value_type * Own(const nsize_type & sizes, value_type * data)
    {
        value_type* oldData = Data;
        Data = data;
        SizesMember.Assign(sizes);
        UpdateStrides();
        return oldData;
    }

    void clear(void)
    {
        Disown();
    }

    void Disown(void)
    {
        delete[] Data;
        Data = 0;
        SizesMember.SetAll(0);
        UpdateStrides();
    }

protected:
    nsize_type SizesMember;
    nstride_type StridesMember;
    value_type* Data;

    void UpdateStrides(void)
    {
        typename nsize_type::const_reverse_iterator sizesIter = SizesMember.rbegin();
        typename nstride_type::reverse_iterator stridesIter = StridesMember.rbegin();
        const typename nstride_type::const_reverse_iterator stridesEnd = StridesMember.rend();
        size_type sizesIter_value;
        stride_type previous_stride;

        if (stridesIter == stridesEnd)
            return;

        *stridesIter = 1;
        previous_stride = 1;
        ++stridesIter;

        for (; stridesIter != stridesEnd;
             ++stridesIter, ++sizesIter)
        {
            sizesIter_value = (*sizesIter == 0) ? 1 : *sizesIter;
            *stridesIter = sizesIter_value * previous_stride;
            previous_stride = *stridesIter;
        }
    }

private:
    // copy constructor private to prevent any call
    vctDynamicNArrayOwner(const ThisType & CMN_UNUSED(other)) {};

};


#endif // _vctDynamicNArrayOwner_h