itkOpenCLVector.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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.txt
 *
 *  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.
 *
 *=========================================================================*/
#ifndef __itkOpenCLVector_h
#define __itkOpenCLVector_h
 
#include "itkOpenCLVectorBase.h"
#include "itkOpenCLBuffer.h"
#include "itkMacro.h"
 
namespace itk
{
template< typename T >
class OpenCLVector : public OpenCLVectorBase
{
public:
 
  typedef OpenCLVector Self;
 
  OpenCLVector();
 
  OpenCLVector( const OpenCLVector< T > & other );
 
  ~OpenCLVector();
 
  OpenCLVector< T > & operator=( const OpenCLVector< T > & other );
 
  bool IsNull() const;
 
  void Release();
 
  bool IsEmpty() const { return this->m_Size == 0; }
 
  std::size_t GetSize() const { return this->m_Size; }
 
  T & operator[]( const std::size_t index );
 
  const T & operator[]( const std::size_t index ) const;
 
  void Read( T * data, const std::size_t count, const std::size_t offset = 0 );
 
  void Write( const T * data, const std::size_t count, const std::size_t offset = 0 );
 
  void Write( const Vector< T > & data, const std::size_t offset = 0 );
 
  OpenCLContext * GetContext() const;
 
  OpenCLBuffer GetBuffer() const;
 
private:
 
  OpenCLVector( OpenCLContext * context,
    const OpenCLMemoryObject::Access access, const std::size_t size );
 
  friend class OpenCLContext;
};
 
//------------------------------------------------------------------------------
template< typename charT, typename traits, typename dataType >
inline
std::basic_ostream< charT, traits > &
operator<<( std::basic_ostream< charT, traits > & strm,
  const OpenCLVector< dataType > & vector )
{
  if( vector.IsNull() )
  {
    strm << "OpenCLVector(null)";
    return strm;
  }
 
  const char indent = ' ';
 
  strm << "OpenCLVector" << std::endl
       << indent << "Size: " << vector.GetSize() << std::endl;
 
  strm << std::endl;
 
  return strm;
}
 
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkOpenCLVector.hxx"
#endif
 
#endif /* __itkOpenCLVector_h */