KMR
Public Member Functions | Public Attributes | List of all members
kmr4py.KVS Class Reference

Public Member Functions

def __del__ (self)
 
def __init__ (self, kmr_or_ckvs, keyty="opaque", valty="opaque")
 
def add (self, key, val)
 
def add_kv (self, key, val)
 
def add_kv_done (self)
 
def concatenate (self, morekvs)
 
def distribute (self, cyclic, mopts)
 
def free (self)
 
def get_element_count (self)
 
def get_field_type (self, key_or_value)
 
def local_element_count (self)
 
def map (self, fn, mopts)
 
def map_for_some (self, fn, mopts)
 
def map_ms (self, fn, mopts)
 
def map_ms_commands (self, fn, xopts)
 
def map_on_rank_zero (self, fn, mopts)
 
def map_once (self, rank_zero_only, fn, mopts)
 
def map_parallel_processes (self, fn, sopts)
 
def map_processes (self, nonmpi, fn, sopts)
 
def map_rank_by_rank (self, fn, mopts)
 
def map_serial_processes (self, fn, sopts)
 
def map_via_spawn (self, fn, xopts)
 
def read_file_by_segments (self, filename, color)
 
def read_files_reassemble (self, filename, color, offset, bytes_)
 
def reduce (self, fn, mopts)
 
def reduce_as_one (self, fn, mopts)
 
def reduce_for_some (self, fn, mopts)
 
def replicate (self, mopts)
 
def restore (self, data)
 
def reverse (self, mopts)
 
def save (self)
 
def shuffle (self, mopts)
 
def sort (self, mopts)
 
def sort_locally (self, shuffling, mopts)
 

Public Attributes

 mr
 Return a dummy KVS. More...
 

Detailed Description

KVS.  Note that there are dummy KVS'es which are temporarily
created to hold the C structure of the KVS passed to
mapper/reducer functions.  A dummy KVS has None in its "mr"
attribute.

Definition at line 833 of file kmr4py.py.

Constructor & Destructor Documentation

◆ __init__()

def kmr4py.KVS.__init__ (   self,
  kmr_or_ckvs,
  keyty = "opaque",
  valty = "opaque" 
)
Makes a KVS for a given KMR.  Do not call the KVS constructor
directly, but use KMR.make_kvs() instead.  A KVS is created
with the datatypes stored in the key and the value, specified
by the keywords "key=" and "value=".  The datatype name is a
string, one of "opaque", "cstring", "integer", and "float8".
Most mappers and reducers (precisely, the methods that accepts
a function argument) take keyword arguments for the types,
defaulting with key="opaque" and value="opaque".  The
datatypes affects the sorting order.  

Definition at line 841 of file kmr4py.py.

Member Function Documentation

◆ free()

def kmr4py.KVS.free (   self)
Finishes the C part of a KVS.

Definition at line 887 of file kmr4py.py.

◆ get_field_type()

def kmr4py.KVS.get_field_type (   self,
  key_or_value 
)
Get a field type of a KVS.

Definition at line 964 of file kmr4py.py.

◆ add()

def kmr4py.KVS.add (   self,
  key,
  val 
)
Adds a key-value pair.

Definition at line 980 of file kmr4py.py.

◆ add_kv()

def kmr4py.KVS.add_kv (   self,
  key,
  val 
)
Adds a key-value pair.

Definition at line 986 of file kmr4py.py.

◆ add_kv_done()

def kmr4py.KVS.add_kv_done (   self)
Finishes adding key-value pairs.

Definition at line 997 of file kmr4py.py.

◆ get_element_count()

def kmr4py.KVS.get_element_count (   self)
Gets the total number of key-value pairs.

Definition at line 1003 of file kmr4py.py.

◆ local_element_count()

def kmr4py.KVS.local_element_count (   self)
Gets the number of key-value pairs locally.

Definition at line 1010 of file kmr4py.py.

◆ map()

def kmr4py.KVS.map (   self,
  fn,
  mopts 
)
Maps simply.

Definition at line 1017 of file kmr4py.py.

◆ map_once()

def kmr4py.KVS.map_once (   self,
  rank_zero_only,
  fn,
  mopts 
)
Maps once with a dummy key-value pair.

Definition at line 1031 of file kmr4py.py.

◆ map_on_rank_zero()

def kmr4py.KVS.map_on_rank_zero (   self,
  fn,
  mopts 
)
Maps on rank0 only.

Definition at line 1043 of file kmr4py.py.

◆ map_rank_by_rank()

def kmr4py.KVS.map_rank_by_rank (   self,
  fn,
  mopts 
)
Maps sequentially with rank by rank for debugging.

Definition at line 1049 of file kmr4py.py.

◆ map_for_some()

def kmr4py.KVS.map_for_some (   self,
  fn,
  mopts 
)
Maps until some key-value are added.

Definition at line 1062 of file kmr4py.py.

◆ map_ms()

def kmr4py.KVS.map_ms (   self,
  fn,
  mopts 
)
Maps in master-worker mode.

Definition at line 1075 of file kmr4py.py.

◆ map_ms_commands()

def kmr4py.KVS.map_ms_commands (   self,
  fn,
  xopts 
)
Maps in master-worker mode, and runs serial commands.

Definition at line 1091 of file kmr4py.py.

◆ map_via_spawn()

def kmr4py.KVS.map_via_spawn (   self,
  fn,
  xopts 
)
Maps on processes started by MPI_Comm_spawn().

Definition at line 1108 of file kmr4py.py.

◆ map_processes()

def kmr4py.KVS.map_processes (   self,
  nonmpi,
  fn,
  sopts 
)
Maps on processes started by MPI_Comm_spawn().

Definition at line 1123 of file kmr4py.py.

◆ map_parallel_processes()

def kmr4py.KVS.map_parallel_processes (   self,
  fn,
  sopts 
)
Maps on processes started by MPI_Comm_spawn().

Definition at line 1137 of file kmr4py.py.

◆ map_serial_processes()

def kmr4py.KVS.map_serial_processes (   self,
  fn,
  sopts 
)
Maps on processes started by MPI_Comm_spawn().

Definition at line 1142 of file kmr4py.py.

◆ reduce()

def kmr4py.KVS.reduce (   self,
  fn,
  mopts 
)
Reduces key-value pairs.

Definition at line 1147 of file kmr4py.py.

◆ reduce_as_one()

def kmr4py.KVS.reduce_as_one (   self,
  fn,
  mopts 
)
Reduces once as if all pairs had the same key.

Definition at line 1161 of file kmr4py.py.

◆ reduce_for_some()

def kmr4py.KVS.reduce_for_some (   self,
  fn,
  mopts 
)
Reduces until some key-value are added.

Definition at line 1174 of file kmr4py.py.

◆ reverse()

def kmr4py.KVS.reverse (   self,
  mopts 
)
Makes a new pair by swapping the key and the value.

Definition at line 1189 of file kmr4py.py.

◆ shuffle()

def kmr4py.KVS.shuffle (   self,
  mopts 
)
Shuffles key-value pairs.

Definition at line 1204 of file kmr4py.py.

◆ replicate()

def kmr4py.KVS.replicate (   self,
  mopts 
)
Replicates key-value pairs to be visible on all ranks.

Definition at line 1218 of file kmr4py.py.

◆ distribute()

def kmr4py.KVS.distribute (   self,
  cyclic,
  mopts 
)
Distributes pairs approximately evenly to ranks.

Definition at line 1232 of file kmr4py.py.

◆ sort_locally()

def kmr4py.KVS.sort_locally (   self,
  shuffling,
  mopts 
)
Reorders key-value pairs in a single rank.

Definition at line 1246 of file kmr4py.py.

◆ sort()

def kmr4py.KVS.sort (   self,
  mopts 
)
Sorts a KVS globally.

Definition at line 1260 of file kmr4py.py.

◆ concatenate()

def kmr4py.KVS.concatenate (   self,
  morekvs 
)
Concatenates a number of KVS'es to one.

Definition at line 1274 of file kmr4py.py.

◆ read_files_reassemble()

def kmr4py.KVS.read_files_reassemble (   self,
  filename,
  color,
  offset,
  bytes_ 
)
Reassembles files reading by ranks.

Definition at line 1293 of file kmr4py.py.

◆ read_file_by_segments()

def kmr4py.KVS.read_file_by_segments (   self,
  filename,
  color 
)
Reads one file by segments and reassembles.

Definition at line 1307 of file kmr4py.py.

◆ save()

def kmr4py.KVS.save (   self)
Packs locally the contents of a KVS to a byte array.

Definition at line 1321 of file kmr4py.py.

◆ restore()

def kmr4py.KVS.restore (   self,
  data 
)
Unpacks locally the contents of a KVS from a byte array.

Definition at line 1334 of file kmr4py.py.

Member Data Documentation

◆ mr

kmr4py.KVS.mr

Return a dummy KVS.

Definition at line 852 of file kmr4py.py.


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