QDP++ Documentation

User Guide

This is the User Guide for the QDP++ data parallel interface for QCD.

• Introduction
  • Disclaimer

• Datatypes in QDP
  • Type Structure
  • Generic Names
  • Specific Types for Color and Precision
  • Color and Precision Uniformity
  • Breaking Color and Precision Uniformity

• QDP Functions
  • Entry and exit from QDP
  • Layout utilities
  • Data Parallel Functions
  • Creating and destroying lattice fields
  • Array container objects
  • Function objects
  • Subsets
  • Maps and shifts
  • Temporary entry and exit from QDP

• Simple I/O utilities
  • Basic structure
  • Text Reading and Writing
  • XML Reading and Writing
  • XML document structure
  • Binary Reading and Writing

• QDP Record I/O utilities
  • Overview of File Format
  • QDP/C++ Record API

• Compilation with QDP
  • Generic header and macros
  • How to configure QDP++
  • Nonuniform color and precision

• Spin Conventions

• Implementation Details

• Supported Operations
  • Subsets and Maps
  • Infix operators
  • Functions
  • Additional functions (specific to QDP)
  • In place functions
  • Broadcasts
  • Global reductions
  • Accessors
  • More exotic functions
  • Operations on subtypes

• Detailed function description
  • Header Files
  • Unary Operations
  • Type conversion
  • Operations on complex arguments
  • Component extraction and insertion
  • Binary Operations with Constants
  • Binary Operations with Fields
  • Boolean and Bit Operations
  • Reductions
  • Fills