Kig Python Scripting API Documentation

Public Member Functions | Static Public Member Functions | List of all members
CubicCartesianData Class Reference

This class represents an equation of a cubic in the form $ a_{ijk} x_i x_j x_k = 0 $ (in homogeneous coordinates, $ i,j,k = 0,1,2 $), $ i <= j <= k $. More...

Public Member Functions

 CubicCartesianData ()
 Default Constructor. More...
 
 CubicCartesianData (double a000, double a001, double a002, double a011, double a012, double a022, double a111, double a112, double a122, double a222)
 Constructor. More...
 
bool valid () const
 Return whether this is a valid CubicCartesianData. More...
 

Static Public Member Functions

static CubicCartesianData invalidData ()
 Create an invalid CubicCartesianData. More...
 

Detailed Description

This class represents an equation of a cubic in the form $ a_{ijk} x_i x_j x_k = 0 $ (in homogeneous coordinates, $ i,j,k = 0,1,2 $), $ i <= j <= k $.

The coefficients are stored in lessicografic order.

Constructor & Destructor Documentation

◆ CubicCartesianData() [1/2]

CubicCartesianData::CubicCartesianData ( )
explicit

Default Constructor.

Constructs a new CubicCartesianData, with all the coeffs initialized to 0.

Referenced by CubicCartesianData().

◆ CubicCartesianData() [2/2]

CubicCartesianData::CubicCartesianData ( double  a000,
double  a001,
double  a002,
double  a011,
double  a012,
double  a022,
double  a111,
double  a112,
double  a122,
double  a222 
)

Constructor.

Construct a new CubicCartesianData, with the given values as coeffs.

References CubicCartesianData(), invalidData(), and valid().

Member Function Documentation

◆ invalidData()

static CubicCartesianData CubicCartesianData::invalidData ( )
static

Create an invalid CubicCartesianData.

This is a special state of a CubicCartesianData that signals that something went wrong..

See also
CubicCartesianData::valid

Referenced by CubicCartesianData().

◆ valid()

bool CubicCartesianData::valid ( ) const

Return whether this is a valid CubicCartesianData.

See also
CubicCartesianData::invalidData

Referenced by CubicCartesianData().

KDE Logo
This file is part of the documentation for tdelibs .
Documentation copyright © 1996-2002 the KDE developers.
Generated on Tue Feb 25 2025 13:46:37 by doxygen 1.8.13 written by Dimitri van Heesch, © 1997-2001