Maps a 3D tensor onto a storage. More...

#include <storage.h>

Classes
struct	Channel

Public Member Functions
	View ()

	View (View &&)

	View (const View &)

View &	operator= (View &&)

	View (Storage &storage)

	View (View &&view, const int firstChannel, const int numChannels)
	Creates a slice of another view. More...

	View (Storage &storage, const int shuffleStep)
	Creates a view by shuffling storage channels. More...

Storage &	getStorage ()

const Storage &	getStorage () const

InternalBitmap *	getImage (Context &ctx, GraphicPipeline &gpu, int channel) const

int	getNumberOfTextures () const
	Returns total number of textures in the storage view. More...

int	getChannelTextureNumber (int channel) const
	Returns number of the texture containing a given channel. More...

IntPoint	getChannelOrigin (int channel) const
	Returns origin in pixels of a given channel within the texture containing it. More...

int	getTextureWidth () const
	Returns width in pixels of all the textures. More...

int	getTextureHeight () const
	Returns height in pixels of all the textures. More...

IntPoint	getTextureSize () const

	operator bool () const
	Conversion operator to a boolean expression (`true` if the view is not empty). More...

Size	getSize () const

IntPoint	getSpatialSize () const
	Returns the spatial size (width and height) of the storage in pixels. More...

int	getWidth () const

int	getHeight () const

int	getDepth () const

Private Attributes
std::vector< Channel >	channels
	channels of the view More...

std::vector< int >	textures
	indices of textures in the storage More...

Storage *	storage

Friends
class	Binder

class	Scanner

class	TextureHandler

Detailed Description

Maps a 3D tensor onto a storage.

Set of storage slices along the depth dimension.

Definition at line 308 of file storage.h.

Constructor & Destructor Documentation

◆ View() [1/6]

Beatmup::NNets::Storage::View::View ( )

inline

Definition at line 323 of file storage.h.

323 : storage(nullptr) {}

Beatmup::NNets::Storage::View::storage

Storage * storage

Definition: storage.h:320

◆ View() [2/6]

Storage::View::View ( View && another )

Definition at line 409 of file storage.cpp.

                                 {
     channels.swap(another.channels);
     textures.swap(another.textures);
     storage = another.storage;
     another.storage = nullptr;
 }

◆ View() [3/6]

Storage::View::View ( const View & another )

Definition at line 402 of file storage.cpp.

                                      {
     channels = another.channels;
     textures = another.textures;
     storage = another.storage;
 }

◆ View() [4/6]

Storage::View::View ( Storage & storage )

Definition at line 426 of file storage.cpp.

                                  :
     channels(storage.getSize()[2] / 4),
     textures(storage.getNumberOfTextures()),
     storage(&storage)
 {
     const int num = storage.getSize()[2] / 4;
     for (int i = 0; i < num; ++i) {
         channels[i].textureIdx = storage.getChannelTextureNumber(4 * i);
         channels[i].channelIdx = 4 * i;
     }
     for (int i = 0; i < storage.getNumberOfTextures(); ++i)
         textures[i] = i;
 }

◆ View() [5/6]

Storage::View::View	(	View &&	view,
		const int	firstChannel,
		const int	numChannels
	)

Creates a slice of another view.

Parameters

[in]	view	The input storage view
[in]	firstChannel	First view channel index in the storage
[in]	numChannels	Number of channels in the view

Definition at line 441 of file storage.cpp.

                                                                            :
     storage(view.storage)
 {
 #ifdef BEATMUP_DEBUG
     Storage::checkChannelNumber(firstChannel);
     Storage::checkChannelNumber(firstChannel + numChannels);
     OutOfRange::check(firstChannel + numChannels, 0, view.getDepth(), "Number of channels out of range: %d");
 #endif
     Bitset usedTextures(storage->getNumberOfTextures(), false);
     for (int i = firstChannel; i < firstChannel + numChannels; i += 4)
         usedTextures.set(view.textures[view.getChannelTextureNumber(i)]);
  
     textures.reserve(usedTextures.count());
     std::map<int, int> textureMap;
     for (int i = 0; i < storage->getNumberOfTextures(); ++i)
         if (usedTextures[i]) {
             textureMap[i] = textures.size();
             textures.emplace_back(i);
         }
  
     channels.reserve(numChannels / 4);
     for (int i = firstChannel; i < firstChannel + numChannels; i += 4) {
         const auto entry = view.channels[i / 4];
         channels.push_back(Channel{ entry.channelIdx, textureMap[entry.textureIdx] });
     }
 }

◆ View() [6/6]

Storage::View::View	(	Storage &	storage,
		const int	shuffleStep
	)

Creates a view by shuffling storage channels.

For shuffling step n, the view will contain the storage channel quads in the following order: 0, 1, 2, 3, 4n, 4n+1, 4n+2, 4n+3, 8n, 8n+1, 8n+2, 8n+3, ..., 4, 5, 6, 7, 4n+4, 4n+5, 4n+6, 4n+7, 8n+4, ...

Parameters

[in]	storage	The storage
[in]	shuffleStep	Shuffling step (n)

Definition at line 469 of file storage.cpp.

                                                         :
     channels(storage.getSize()[2] / 4),
     textures(storage.getNumberOfTextures()),
     storage(&storage)
 {
     const int num = storage.getSize()[2] / 4;
 #ifdef BEATMUP_DEBUG
     OutOfRange::checkMin(shuffleStep, 1, "Shuffling step must be positive, but %d got");
 #endif
     RuntimeError::check(num % shuffleStep == 0, "Shuffling step *4 must be a divider of the storage depth");
  
     for (int i = 0; i < storage.getNumberOfTextures(); ++i)
         textures[i] = i;
  
     for (int i = 0; i < num; ++i) {
         const int shuffled = 4 * ((shuffleStep * i) % num + (shuffleStep * i) / num);
         channels[i].textureIdx = storage.getChannelTextureNumber(shuffled);
         channels[i].channelIdx = shuffled;
     }
 }

Member Function Documentation

◆ operator=()

Storage::View & Storage::View::operator= ( View && another )

Definition at line 417 of file storage.cpp.

                                                   {
     channels.swap(another.channels);
     textures.swap(another.textures);
     storage = another.storage;
     another.storage = nullptr;
     return *this;
 }

◆ getStorage() [1/2]

Storage& Beatmup::NNets::Storage::View::getStorage ( )

inline

Definition at line 347 of file storage.h.

347 { return *storage; }

◆ getStorage() [2/2]

const Storage& Beatmup::NNets::Storage::View::getStorage ( ) const

inline

Definition at line 348 of file storage.h.

348 { return *storage; }

◆ getImage()

InternalBitmap * Storage::View::getImage	(	Context &	ctx,
		GraphicPipeline &	gpu,
		int	channel
	)		const

Definition at line 491 of file storage.cpp.

                                                                                            {
 #ifdef BEATMUP_DEBUG
     OutOfRange::check(channel, 0, getDepth() - 1, "Channel index out of range: %d");
 #endif
     const int storageChannel = channels[channel / 4].channelIdx + (channel % 4);
     return storage->getImage(ctx, gpu, storageChannel);
 }

◆ getNumberOfTextures()

int Beatmup::NNets::Storage::View::getNumberOfTextures ( ) const

inline

Returns total number of textures in the storage view.

Definition at line 355 of file storage.h.

355 { return (int)textures.size(); }

◆ getChannelTextureNumber()

int Storage::View::getChannelTextureNumber ( int channel ) const

Returns number of the texture containing a given channel.

Definition at line 500 of file storage.cpp.

                                                           {
 #ifdef BEATMUP_DEBUG
     Storage::checkChannelNumber(channel);
     OutOfRange::check(channel, 0, getDepth() - 1, "Channel index out of range: %d");
 #endif
     return channels[channel / 4].textureIdx;
 }

◆ getChannelOrigin()

IntPoint Storage::View::getChannelOrigin ( int channel ) const

Returns origin in pixels of a given channel within the texture containing it.

Definition at line 509 of file storage.cpp.

                                                         {
 #ifdef BEATMUP_DEBUG
     Storage::checkChannelNumber(channel);
     OutOfRange::check(channel, 0, getDepth() - 1, "Channel index out of range: %d");
 #endif
     const Channel& ch = channels[channel / 4];
     return storage->getChannelOrigin(ch.channelIdx);
 }

◆ getTextureWidth()

int Beatmup::NNets::Storage::View::getTextureWidth ( ) const

inline

Returns width in pixels of all the textures.

Definition at line 370 of file storage.h.

370 { return storage->getTextureWidth(); }

Beatmup::NNets::Storage::getTextureWidth

int getTextureWidth() const

Returns width in pixels of all the textures.

Definition: storage.cpp:390

◆ getTextureHeight()

int Beatmup::NNets::Storage::View::getTextureHeight ( ) const

inline

Returns height in pixels of all the textures.

Definition at line 375 of file storage.h.

375 { return storage->getTextureHeight(); }

Beatmup::NNets::Storage::getTextureHeight

int getTextureHeight() const

Returns height in pixels of all the textures.

Definition: storage.cpp:395

◆ getTextureSize()

IntPoint Beatmup::NNets::Storage::View::getTextureSize ( ) const

inline

Definition at line 377 of file storage.h.

377 { return IntPoint(storage->getTextureWidth(), storage->getTextureHeight()); }

Beatmup::IntPoint

CustomPoint< int > IntPoint

Definition: geometry.h:629

◆ operator bool()

Beatmup::NNets::Storage::View::operator bool ( ) const

inline

Conversion operator to a boolean expression (true if the view is not empty).

Definition at line 382 of file storage.h.

382 { return storage != nullptr; }

◆ getSize()

Size Beatmup::NNets::Storage::View::getSize ( ) const

inline

Definition at line 384 of file storage.h.

384 { return storage->getSize(); }

◆ getSpatialSize()

IntPoint Beatmup::NNets::Storage::View::getSpatialSize ( ) const

inline

Returns the spatial size (width and height) of the storage in pixels.

Definition at line 389 of file storage.h.

                                                        {
                     const Size size = storage->getSize();
                     return IntPoint(size[0], size[1]);
                 };

◆ getWidth()

int Beatmup::NNets::Storage::View::getWidth ( ) const

inline

Definition at line 394 of file storage.h.

394 { return storage->size[0]; }

◆ getHeight()

int Beatmup::NNets::Storage::View::getHeight ( ) const

inline

Definition at line 395 of file storage.h.

395 { return storage->size[1]; }

◆ getDepth()

int Beatmup::NNets::Storage::View::getDepth ( ) const

inline

Definition at line 396 of file storage.h.

396 { return 4 * (int)channels.size(); }

Friends And Related Function Documentation

◆ Binder

friend class Binder

friend

Definition at line 309 of file storage.h.

◆ Scanner

friend class Scanner

friend

Definition at line 310 of file storage.h.

◆ TextureHandler

friend class TextureHandler

friend

Definition at line 311 of file storage.h.

Member Data Documentation

◆ channels

std::vector<Channel> Beatmup::NNets::Storage::View::channels

private

channels of the view

Definition at line 318 of file storage.h.

◆ textures

std::vector<int> Beatmup::NNets::Storage::View::textures

private

indices of textures in the storage

Definition at line 319 of file storage.h.

◆ storage

Storage* Beatmup::NNets::Storage::View::storage

private

Definition at line 320 of file storage.h.

The documentation for this class was generated from the following files:

core/nnets/storage.h
core/nnets/storage.cpp

Classes

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ View() [1/6]

◆ View() [2/6]

◆ View() [3/6]

◆ View() [4/6]

◆ View() [5/6]

◆ View() [6/6]

Member Function Documentation

◆ operator=()

◆ getStorage() [1/2]

◆ getStorage() [2/2]

◆ getImage()

◆ getNumberOfTextures()

◆ getChannelTextureNumber()

◆ getChannelOrigin()

◆ getTextureWidth()

◆ getTextureHeight()

◆ getTextureSize()

◆ operator bool()

◆ getSize()

◆ getSpatialSize()

◆ getWidth()

◆ getHeight()

◆ getDepth()

Friends And Related Function Documentation

◆ Binder

◆ Scanner

◆ TextureHandler

Member Data Documentation

◆ channels

◆ textures

◆ storage