Initializing help system before first use

Array

Class for passing arrays to Xpress library functions. More...

#include <xpress.hpp>

Inheritance diagram for xpress::Array< T >:
xpress::SizedArray< T >

Public Types

typedef T  value_type
  The type of data in this array.
 

Public Member Functions

  Array ()
  Create a null array.
 
template<std::size_t N>
  Array (std::array< T, N > &d)
  Create a new array descriptor from a std::array.
 
template<std::size_t N>
  Array (std::array< typename std::remove_const< T >::type, N > const &d)
  Create a new array descriptor from a std::array.
 
  Array (std::nullptr_t)
  Create an array from a null pointer.
 
  Array (std::vector< T > &d)
  Create a new array descriptor from a std::vector.
 
  Array (std::vector< typename std::remove_const< T >::type > const &d)
  Create a new array descriptor from a std::vector.
 
  Array (T *d)
  Create a new array descriptor from a C style array.
 

Public Attributes

value_type data
  The underlying C style array.
 

Detailed Description

template<typename T>
class xpress::Array< T >

Class for passing arrays to Xpress library functions.

All arrays passed to the Xpress library are passed as instances of this class. Using this class allows passing arrays as plain C arrays, as instances of std::array or std::vector.

Note that for std::array and std::vector the constructor extracts a pointer to the underlying raw data storage. So this storage must stay alive for the lifetime of the Array instance, otherwise undefined behavior will occur.

You should not have to deal with this class explicitly. It only exists to simplify argument passing to Xpress functions. It provides flexibility without creating a large amount of overloads.

Constructor & Destructor Documentation

Array() [1/5]

template<typename T >
xpress::Array< T >::Array ( T * d )
inline

Create a new array descriptor from a C style array.

Parameters
d The C style array.

Array() [2/5]

template<typename T >
xpress::Array< T >::Array ( std::vector< T > & d )
inline

Create a new array descriptor from a std::vector.

Parameters
d The vector.

Array() [3/5]

template<typename T >
xpress::Array< T >::Array ( std::vector< typename std::remove_const< T >::type > const & d )
inline

Create a new array descriptor from a std::vector.

Parameters
d The vector.

Array() [4/5]

template<typename T >
template<std::size_t N>
xpress::Array< T >::Array ( std::array< T, N > & d )
inline

Create a new array descriptor from a std::array.

Parameters
d The array.

Array() [5/5]

template<typename T >
template<std::size_t N>
xpress::Array< T >::Array ( std::array< typename std::remove_const< T >::type, N > const & d )
inline

Create a new array descriptor from a std::array.

Parameters
d The array.

The documentation for this class was generated from the following file:
  • xpress.hpp

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.