Remove \nonstable yet. The stability rules for Eigen3 are much simpler:

- all what's not in unsupported/ is considered stable API
    (except internal stuff e.g. expression templates).
This commit is contained in:
Benoit Jacob
2010-06-29 10:10:47 -04:00
parent 76152e9844
commit e5de9e5226
39 changed files with 51 additions and 54 deletions

View File

@@ -25,7 +25,7 @@
#ifndef EIGEN_BANDMATRIX_H
#define EIGEN_BANDMATRIX_H
/** \nonstableyet
/**
* \class BandMatrix
*
* \brief Represents a rectangular matrix with a banded storage
@@ -203,7 +203,7 @@ class BandMatrix : public EigenBase<BandMatrix<_Scalar,Rows,Cols,Supers,Subs,Opt
ei_variable_if_dynamic<Index, Subs> m_subs;
};
/** \nonstableyet
/**
* \class TridiagonalMatrix
*
* \brief Represents a tridiagonal matrix

View File

@@ -25,7 +25,7 @@
#ifndef EIGEN_REPLICATE_H
#define EIGEN_REPLICATE_H
/** \nonstableyet
/**
* \class Replicate
*
* \brief Expression of the multiple replication of a matrix or vector
@@ -125,7 +125,7 @@ template<typename MatrixType,int RowFactor,int ColFactor> class Replicate
const ei_variable_if_dynamic<Index, ColFactor> m_colFactor;
};
/** \nonstableyet
/**
* \return an expression of the replication of \c *this
*
* Example: \include MatrixBase_replicate.cpp
@@ -141,7 +141,7 @@ DenseBase<Derived>::replicate() const
return Replicate<Derived,RowFactor,ColFactor>(derived());
}
/** \nonstableyet
/**
* \return an expression of the replication of \c *this
*
* Example: \include MatrixBase_replicate_int_int.cpp
@@ -156,7 +156,7 @@ DenseBase<Derived>::replicate(Index rowFactor,Index colFactor) const
return Replicate<Derived,Dynamic,Dynamic>(derived(),rowFactor,colFactor);
}
/** \nonstableyet
/**
* \return an expression of the replication of each column (or row) of \c *this
*
* Example: \include DirectionWise_replicate_int.cpp

View File

@@ -26,7 +26,7 @@
#define EIGEN_SELFADJOINTMATRIX_H
/** \class SelfAdjointView
* \nonstableyet
*
*
* \brief Expression of a selfadjoint matrix from a triangular part of a dense matrix
*

View File

@@ -234,7 +234,7 @@ struct ei_triangular_solver_selector<Lhs,Rhs,OnTheLeft,Mode,CompleteUnrolling,St
/** "in-place" version of TriangularView::solve() where the result is written in \a other
*
* \nonstableyet
*
*
* \warning The parameter is only marked 'const' to make the C++ compiler accept a temporary expression here.
* This function will const_cast it, so constness isn't honored here.
@@ -265,7 +265,7 @@ void TriangularView<MatrixType,Mode>::solveInPlace(const MatrixBase<OtherDerived
/** \returns the product of the inverse of \c *this with \a other, \a *this being triangular.
*
* \nonstableyet
*
*
* This function computes the inverse-matrix matrix product inverse(\c *this) * \a other.
* The matrix \c *this must be triangular and invertible (i.e., all the coefficients of the

View File

@@ -621,7 +621,7 @@ EIGEN_DEPRECATED TriangularView<Derived, Mode> MatrixBase<Derived>::part()
return derived();
}
/** \nonstableyet
/**
* \returns an expression of a triangular view extracted from the current matrix
*
* The parameter \a Mode can have the following values: \c Upper, \c StrictlyUpper, \c UnitUpper,

View File

@@ -388,7 +388,7 @@ template<typename ExpressionType, int Direction> class VectorwiseOp
typedef Replicate<ExpressionType,Direction==Vertical?Dynamic:1,Direction==Horizontal?Dynamic:1> ReplicateReturnType;
const ReplicateReturnType replicate(Index factor) const;
/** \nonstableyet
/**
* \return an expression of the replication of each column (or row) of \c *this
*
* Example: \include DirectionWise_replicate.cpp