Initializing help system before first use

PwlBreakpoint

A breakpoint in a piecewise linear function. More...

#include <xpress.hpp>

Public Member Functions
  PwlBreakpoint ()
  Create a breakpoint (0,0).
 
  PwlBreakpoint (double x, double y)
  Create a breakpoint with the specified coordinates.
 
auto  compareTo (PwlBreakpoint const &other) const -> int
 
auto  equals (PwlBreakpoint const &other) const -> bool
 
auto  getHashCode () const -> std::size_t
 
auto  getX () const -> double
  X coordinate [get].
 
auto  getY () const -> double
  Y coordinate [get].
 
auto  operator!= (PwlBreakpoint const &other) const -> bool
 
auto  operator== (PwlBreakpoint const &other) const -> bool
 
void  setX (double newX)
  X coordinate [set].
 
void  setY (double newY)
  Y coordinate [set].
 

Static Public Member Functions
template<typename Strm0 , typename Strm0IsStream = typename std::enable_if<xpress::is_stream<Strm0>::value>::type>
static auto  convert (Strm0 const &breakpoints) -> std::vector< std::vector< double > >
  Convert a collection of breakpoints into two double arrays.
 
static auto  convert (xpress::SizedArray< double const > const &xval, xpress::SizedArray< double const > const &yval) -> std::vector< xpress::PwlBreakpoint >
  Convert arrays of coordinates into breakpoints.
 

Detailed Description

A breakpoint in a piecewise linear function.

Since
44.00

Constructor & Destructor Documentation

PwlBreakpoint() [1/2]

xpress::PwlBreakpoint::PwlBreakpoint ( )
inline

Create a breakpoint (0,0).

Since
44.00

PwlBreakpoint() [2/2]

xpress::PwlBreakpoint::PwlBreakpoint ( double x,
double y )
inline

Create a breakpoint with the specified coordinates.

Parameters
x X coordinate for breakpoint.
y Y coordinate for breakpoint.
Since
44.00

Member Function Documentation

compareTo()

auto xpress::PwlBreakpoint::compareTo ( PwlBreakpoint const & other ) const -> int
inline
Since
44.00

convert() [1/2]

template<typename Strm0 , typename Strm0IsStream = typename std::enable_if<xpress::is_stream<Strm0>::value>::type>
static auto xpress::PwlBreakpoint::convert ( Strm0 const & breakpoints ) -> std::vector< std::vector< double > >
inlinestatic

Convert a collection of breakpoints into two double arrays.

Parameters
breakpoints Breakpoints to convert.
Template Parameters
Strm0 Something that supports begin() and end() and contains values of type xpress::PwlBreakpoint.
Returns
Two element array, in which the first element contains the x coordinates of the breakpoints and the second element contains the y coordinates of the breakpoints.
Since
44.00

convert() [2/2]

static auto xpress::PwlBreakpoint::convert ( xpress::SizedArray< double const > const & xval,
xpress::SizedArray< double const > const & yval ) -> std::vector< xpress::PwlBreakpoint >
inlinestatic

Convert arrays of coordinates into breakpoints.

Parameters
xval x coordinates of breakpoints. Must have the same length as yval.
yval y coordinates of breakpoints. Must have the same length as xval.
Returns
The breakpoints represented by xval and yval.
Since
44.00

equals()

auto xpress::PwlBreakpoint::equals ( PwlBreakpoint const & other ) const -> bool
inline
Since
44.00

getHashCode()

auto xpress::PwlBreakpoint::getHashCode ( ) const -> std::size_t
inline
Since
44.00

getX()

auto xpress::PwlBreakpoint::getX ( ) const -> double
inline

X coordinate [get].

Since
44.00

getY()

auto xpress::PwlBreakpoint::getY ( ) const -> double
inline

Y coordinate [get].

Since
44.00

operator!=()

auto xpress::PwlBreakpoint::operator!= ( PwlBreakpoint const & other ) const -> bool
inline
Since
44.00

operator==()

auto xpress::PwlBreakpoint::operator== ( PwlBreakpoint const & other ) const -> bool
inline
Since
44.00

setX()

void xpress::PwlBreakpoint::setX ( double newX )
inline

X coordinate [set].

Since
44.00

setY()

void xpress::PwlBreakpoint::setY ( double newY )
inline

Y coordinate [set].

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

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