All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
awkward::util Namespace Reference

Classes

class  array_deleter
 Used as a std::shared_ptr deleter (second argument) to overload delete ptr with delete[] ptr. More...
 

Enumerations

enum class  dtype {
  NOT_PRIMITIVE , boolean , int8 , int16 ,
  int32 , int64 , uint8 , uint16 ,
  uint32 , uint64 , float16 , float32 ,
  float64 , float128 , complex64 , complex128 ,
  complex256 , datetime64 , timedelta64 , size
}
 NumPy dtypes that can be interpreted within Awkward C++ (only the primitive, fixed-width types). Non-native-endian types are considered NOT_PRIMITIVE. More...
 
enum class  ForthError {
  none , not_ready , is_done , user_halt ,
  recursion_depth_exceeded , stack_underflow , stack_overflow , read_beyond ,
  seek_beyond , skip_beyond , rewind_beyond , division_by_zero ,
  varint_too_big , text_number_missing , quoted_string_missing , enumeration_missing ,
  size
}
 Exhaustive list of runtime errors possible in the ForthMachine. More...
 

Functions

const std::string dtype_to_name (dtype dt)
 Returns the name associated with a given dtype.
 
const std::string dtype_to_format (dtype dt, const std::string &format="")
 Convert a dtype enum into a NumPy format string.
 
std::string quote (const std::string &x)
 Puts quotation marks around a string and escapes the appropriate characters.
 

Enumeration Type Documentation

◆ dtype

enum class dtype
strong

NumPy dtypes that can be interpreted within Awkward C++ (only the primitive, fixed-width types). Non-native-endian types are considered NOT_PRIMITIVE.

Enumerator
NOT_PRIMITIVE 
boolean 
int8 
int16 
int32 
int64 
uint8 
uint16 
uint32 
uint64 
float16 
float32 
float64 
float128 
complex64 
complex128 
complex256 
datetime64 
timedelta64 
size 

◆ ForthError

enum class ForthError
strong

Exhaustive list of runtime errors possible in the ForthMachine.

Enumerator
none 
not_ready 
is_done 
user_halt 
recursion_depth_exceeded 
stack_underflow 
stack_overflow 
read_beyond 
seek_beyond 
skip_beyond 
rewind_beyond 
division_by_zero 
varint_too_big 
text_number_missing 
quoted_string_missing 
enumeration_missing 
size 

Function Documentation

◆ dtype_to_format()

const std::string dtype_to_format ( dtype  dt,
const std::string &  format = "" 
)

Convert a dtype enum into a NumPy format string.

◆ dtype_to_name()

const std::string dtype_to_name ( dtype  dt)

Returns the name associated with a given dtype.

◆ quote()

std::string quote ( const std::string &  x)

Puts quotation marks around a string and escapes the appropriate characters.

Parameters
xThe string to quote.
doublequoteIf true, apply double-quotes ("</tt>); if <tt>false</tt>, apply single-quotes (&lsquo;&rsquo;`). @note The implementation does not yet escape characters: it only adds strings. See issue <a href="https://github.com/scikit-hep/awkward-1.0/issues/186" >scikit-hep/awkward-1.0#186.