turi::sgraph_compute::vertex_block< SIterableType > Class Template Reference

#include <core/storage/sgraph_data/sgraph_compute_vertex_block.hpp>

Public Member Functions
void	load_if_not_loaded (const SIterableType &sf)
void	load (const SIterableType &sf)
void	unload ()
bool	is_loaded ()
bool	is_modified ()
void	set_modified_flag ()
void	clear_modified_flag ()

Public Attributes
std::vector< typename SIterableType::value_type >	m_vertices
	The loaded data.

Detailed Description

template<typename SIterableType>
class turi::sgraph_compute::vertex_block< SIterableType >

Represents a partition of vertices which is held in memory.

Definition at line 32 of file sgraph_compute_vertex_block.hpp.

Member Function Documentation

clear_modified_flag()

template<typename SIterableType>

void turi::sgraph_compute::vertex_block< SIterableType >::clear_modified_flag ( )

inline

Clears the modified flag

Definition at line 111 of file sgraph_compute_vertex_block.hpp.

is_loaded()

template<typename SIterableType>

bool turi::sgraph_compute::vertex_block< SIterableType >::is_loaded ( )

inline

Returns true if the SFrame is loaded. False otherwise.

Definition at line 90 of file sgraph_compute_vertex_block.hpp.

is_modified()

template<typename SIterableType>

bool turi::sgraph_compute::vertex_block< SIterableType >::is_modified ( )

inline

Returns true if the SFrame is modified. False otherwise.

Definition at line 97 of file sgraph_compute_vertex_block.hpp.

load()

template<typename SIterableType>

void turi::sgraph_compute::vertex_block< SIterableType >::load ( const SIterableType &  sf )

inline

Loads an SFrame/SArray into memory (accessible directly via m_vertices) reloading it if it has already been loaded.

Definition at line 50 of file sgraph_compute_vertex_block.hpp.

load_if_not_loaded()

template<typename SIterableType>

void turi::sgraph_compute::vertex_block< SIterableType >::load_if_not_loaded ( const SIterableType &  sf )

inline

Loads an SFrame/SArray into memory (accessible directly via m_vertices) if not already loaded.

Definition at line 39 of file sgraph_compute_vertex_block.hpp.

set_modified_flag()

template<typename SIterableType>

void turi::sgraph_compute::vertex_block< SIterableType >::set_modified_flag ( )

inline

Sets the modified flag

Definition at line 104 of file sgraph_compute_vertex_block.hpp.

unload()

template<typename SIterableType>

void turi::sgraph_compute::vertex_block< SIterableType >::unload ( )

inline

Unloads the loaded data, releasing all memory used.

Definition at line 77 of file sgraph_compute_vertex_block.hpp.

---

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

• core/storage/sgraph_data/sgraph_compute_vertex_block.hpp