All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
blaze::BoxLCP Struct Reference

A box linear complementarity problem (BLCP) data structure.The BoxLCP class represent a box linear complementarity problem (BLCP) of the form $ A \cdot x + b \leq 0 \quad\perp\quad \underline{x} \leq x \leq \bar{x} $. More...

#include <BoxLCP.h>

Public Member Functions

Utility functions
size_t size () const
 Returns the size of the BLCP.
 
void project (size_t index)
 Projects the unknown at the given index on the solution range.
 
real lbound (size_t index) const
 Returns the lower bound of the unknown at the given index.
 
real ubound (size_t index) const
 Returns the upper bound of the unknown at the given index.
 
real residual (size_t index) const
 Calculates the residual of the unknown at the given index.
 
real residual () const
 Calculates the maximum norm of the residual of the BLCP.
 

Public Attributes

Member variables
CMatMxN A_
 The system matrix $ A $.
 
VecN b_
 The right-hand side vector $ b $.
 
VecN x_
 The vector of unknowns $ x $.
 
VecN xmin_
 The lower bound of the BLCP.
 
VecN xmax_
 The upper bound of the BLCP.
 

Detailed Description

A box linear complementarity problem (BLCP) data structure.

The BoxLCP class represent a box linear complementarity problem (BLCP) of the form $ A \cdot x + b \leq 0 \quad\perp\quad \underline{x} \leq x \leq \bar{x} $.

Member Function Documentation

real blaze::BoxLCP::lbound ( size_t  index) const
inline

Returns the lower bound of the unknown at the given index.

Parameters
indexAccess index. The index has to be in the range $ [0..size) $.
Returns
void
void blaze::BoxLCP::project ( size_t  index)
inline

Projects the unknown at the given index on the solution range.

Parameters
indexAccess index. The index has to be in the range $ [0..size) $.
Returns
void
real blaze::BoxLCP::residual ( size_t  index) const
inline

Calculates the residual of the unknown at the given index.

Parameters
indexAccess index. The index has to be in the range $ [0..size) $.
Returns
The residual at index index.
real blaze::BoxLCP::residual ( ) const
inline

Calculates the maximum norm of the residual of the BLCP.

Returns
The maximum norm of the global residual of the BLCP.
size_t blaze::BoxLCP::size ( ) const
inline

Returns the size of the BLCP.

Returns
The actual size of the BLCP.
real blaze::BoxLCP::ubound ( size_t  index) const
inline

Returns the upper bound of the unknown at the given index.

Parameters
indexAccess index. The index has to be in the range $ [0..size) $.
Returns
void

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