Initializing help system before first use

SizedArray

Similar to class Array but this class also knows the length of the array. More...

#include <xpress.hpp>

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

Public Member Functions

  SizedArray ()
  Create a null array.
 
template<size_type N>
  SizedArray (std::array< T, N > &d)
  Create a new array descriptor from a std::array.
 
template<size_type N>
  SizedArray (std::array< typename std::remove_const< T >::type, N > const &d)
  Create a new array descriptor from a std::array.
 
  SizedArray (std::nullptr_t)
  Create an array from a null pointer.
 
  SizedArray (std::vector< T > &d)
  Create a new array descriptor from a std::vector.
 
  SizedArray (std::vector< typename std::remove_const< T >::type > const &d)
  Create a new array descriptor from a std::vector.
 
  SizedArray (T *d, size_type l)
  Create a new array descriptor from a C-style array and a length.
 
 Public Member Functions inherited from xpress::Array< T >
  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.
 

Additional Inherited Members

 Public Types inherited from xpress::Array< T >
typedef T  value_type
  The type of data in this array.
 
 Public Attributes inherited from xpress::Array< T >
value_type data
  The underlying C style array.
 

Detailed Description

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

Similar to class Array but this class also knows the length of the array.

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

SizedArray() [1/5]

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

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

Parameters
d The vector.

SizedArray() [2/5]

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

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

Parameters
d The vector.

SizedArray() [3/5]

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

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

Parameters
d The array.

SizedArray() [4/5]

template<typename T >
template<size_type N>
xpress::SizedArray< T >::SizedArray ( 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.

SizedArray() [5/5]

template<typename T >
xpress::SizedArray< T >::SizedArray ( T * d,
size_type l )
inline

Create a new array descriptor from a C-style array and a length.

Parameters
d The array.
l Length of the array.

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

© 2001-2024 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.