number &diag_element (const unsigned int i);
/**
- * Access to values in internal
- * mode. Returns the value of
- * the <tt>index</tt>th entry in
- * <tt>row</tt>. Here,
- * <tt>index</tt> refers to the
- * internal representation of the
- * matrix, not the column. Be
- * sure to understand what you
- * are doing here.
+ * Access to values in internal mode. Returns the value of the
+ * <tt>index</tt>th entry in <tt>row</tt>. Here, <tt>index</tt> refers to
+ * the internal representation of the matrix, not the column. Be sure to
+ * understand what you are doing here.
*
- * @deprecated Use iterator or
- * const_iterator instead!
+ * @deprecated Use iterator or const_iterator instead!
*/
number raw_entry (const unsigned int row,
- const unsigned int index) const;
+ const unsigned int index) const DEAL_II_DEPRECATED;
/**
- * @internal @deprecated Use iterator or
- * const_iterator instead!
- *
- * This is for hackers. Get
- * access to the <i>i</i>th element of
- * this matrix. The elements are
- * stored in a consecutive way,
- * refer to the SparsityPattern
- * class for more details.
- *
- * You should use this interface
- * very carefully and only if you
- * are absolutely sure to know
- * what you do. You should also
- * note that the structure of
- * these arrays may change over
- * time. If you change the
- * layout yourself, you should
- * also rename this function to
- * avoid programs relying on
- * outdated information!
+ * This is for hackers. Get access to the <i>i</i>th element of this
+ * matrix. The elements are stored in a consecutive way, refer to the
+ * SparsityPattern class for more details.
+ *
+ * You should use this interface very carefully and only if you are
+ * absolutely sure to know what you do. You should also note that the
+ * structure of these arrays may change over time. If you change the layout
+ * yourself, you should also rename this function to avoid programs relying
+ * on outdated information!
+ *
+ * @internal @deprecated Use iterator or const_iterator instead!
*/
- number global_entry (const unsigned int i) const;
+ number global_entry (const unsigned int i) const DEAL_II_DEPRECATED;
/**
- * @internal @deprecated Use iterator or
- * const_iterator instead!
+ * Same as above, but with write access. You certainly know what you do?
*
- * Same as above, but with write
- * access. You certainly know
- * what you do?
+ * @internal @deprecated Use iterator or const_iterator instead!
*/
- number &global_entry (const unsigned int i);
+ number &global_entry (const unsigned int i) DEAL_II_DEPRECATED;
//@}
/**
*/
// @{
/**
- * Return the index of the matrix
- * element with row number <tt>i</tt>
- * and column number <tt>j</tt>. If
- * the matrix element is not a
- * nonzero one, return
- * SparsityPattern::invalid_entry.
+ * Return the index of the matrix element with row number <tt>i</tt> and
+ * column number <tt>j</tt>. If the matrix element is not a nonzero one,
+ * return SparsityPattern::invalid_entry.
*
- * This function is usually
- * called by the
- * SparseMatrix::operator()(). It
- * may only be called for
- * compressed sparsity patterns,
- * since in this case searching
- * whether the entry exists can
- * be done quite fast with a
- * binary sort algorithm because
- * the column numbers are sorted.
+ * This function is usually called by the SparseMatrix::operator()(). It may
+ * only be called for compressed sparsity patterns, since in this case
+ * searching whether the entry exists can be done quite fast with a binary
+ * sort algorithm because the column numbers are sorted.
*
- * If <tt>m</tt> is the number of
- * entries in <tt>row</tt>, then the
- * complexity of this function is
- * <i>log(m)</i> if the sparsity
- * pattern is compressed.
+ * If <tt>m</tt> is the number of entries in <tt>row</tt>, then the
+ * complexity of this function is <i>log(m)</i> if the sparsity pattern is
+ * compressed.
*
- * @deprecated Use
- * SparseMatrix::const_iterator
+ * @deprecated Use SparseMatrix::const_iterator
*/
unsigned int operator() (const unsigned int i,
- const unsigned int j) const;
+ const unsigned int j) const DEAL_II_DEPRECATED;
/**
- * This is the inverse operation
- * to operator()(): given a
- * global index, find out row and
- * column of the matrix entry to
- * which it belongs. The returned
- * value is the pair composed of
- * row and column index.
+ * This is the inverse operation to operator()(): given a global index, find
+ * out row and column of the matrix entry to which it belongs. The returned
+ * value is the pair composed of row and column index.
*
- * This function may only be
- * called if the sparsity pattern
- * is closed. The global index
- * must then be between zero and
- * n_nonzero_elements().
+ * This function may only be called if the sparsity pattern is closed. The
+ * global index must then be between zero and n_nonzero_elements().
*
- * If <tt>N</tt> is the number of
- * rows of this matrix, then the
- * complexity of this function is
- * <i>log(N)</i>.
+ * If <tt>N</tt> is the number of rows of this matrix, then the complexity
+ * of this function is <i>log(N)</i>.
*/
std::pair<unsigned int, unsigned int>
matrix_position (const unsigned int global_index) const;
*/
// @{
/**
- * @deprecated
- * This function is deprecated. Use
- * SparsityTools::partition instead.
- *
- * Use the METIS partitioner to generate
- * a partitioning of the degrees of
- * freedom represented by this sparsity
- * pattern. In effect, we view this
- * sparsity pattern as a graph of
- * connections between various degrees of
- * freedom, where each nonzero entry in
- * the sparsity pattern corresponds to an
- * edge between two nodes in the
- * connection graph. The goal is then to
- * decompose this graph into groups of
- * nodes so that a minimal number of
- * edges are cut by the boundaries
- * between node groups. This partitioning
- * is done by METIS. Note that METIS can
- * only partition symmetric sparsity
- * patterns, and that of course the
- * sparsity pattern has to be square. We
- * do not check for symmetry of the
- * sparsity pattern, since this is an
- * expensive operation, but rather leave
- * this as the responsibility of caller
- * of this function.
- *
- * After calling this function, the
- * output array will have values between
- * zero and @p n_partitions-1 for each
- * node (i.e. row or column of the
+ * @deprecated This function is deprecated. Use SparsityTools::partition
+ * instead.
+ *
+ * Use the METIS partitioner to generate a partitioning of the degrees of
+ * freedom represented by this sparsity pattern. In effect, we view this
+ * sparsity pattern as a graph of connections between various degrees of
+ * freedom, where each nonzero entry in the sparsity pattern corresponds to
+ * an edge between two nodes in the connection graph. The goal is then to
+ * decompose this graph into groups of nodes so that a minimal number of
+ * edges are cut by the boundaries between node groups. This partitioning is
+ * done by METIS. Note that METIS can only partition symmetric sparsity
+ * patterns, and that of course the sparsity pattern has to be square. We do
+ * not check for symmetry of the sparsity pattern, since this is an
+ * expensive operation, but rather leave this as the responsibility of
+ * caller of this function.
+ *
+ * After calling this function, the output array will have values between
+ * zero and @p n_partitions-1 for each node (i.e. row or column of the
* matrix).
*
- * This function will generate an error
- * if METIS is not installed unless
- * @p n_partitions is one. I.e., you can
- * write a program so that it runs in the
- * single-processor single-partition case
- * without METIS installed, and only
- * requires METIS when multiple
- * partitions are required.
+ * This function will generate an error if METIS is not installed unless @p
+ * n_partitions is one. I.e., you can write a program so that it runs in the
+ * single-processor single-partition case without METIS installed, and only
+ * requires METIS when multiple partitions are required.
*
- * Note that the sparsity pattern itself
- * is not changed by calling this
- * function. However, you will likely use
- * the information generated by calling
- * this function to renumber degrees of
- * freedom, after which you will of
- * course have to regenerate the sparsity
- * pattern.
+ * Note that the sparsity pattern itself is not changed by calling this
+ * function. However, you will likely use the information generated by
+ * calling this function to renumber degrees of freedom, after which you
+ * will of course have to regenerate the sparsity pattern.
*
- * This function will rarely be called
- * separately, since in finite element
- * methods you will want to partition the
- * mesh, not the matrix. This can be done
- * by calling
- * @p GridTools::partition_triangulation.
+ * This function will rarely be called separately, since in finite element
+ * methods you will want to partition the mesh, not the matrix. This can be
+ * done by calling @p GridTools::partition_triangulation.
*/
void partition (const unsigned int n_partitions,
- std::vector<unsigned int> &partition_indices) const;
+ std::vector<unsigned int> &partition_indices) const DEAL_II_DEPRECATED;
/**
- * @deprecated This is kind of an expert mode. Get
- * access to the rowstart array, but
- * read-only.
+ * @deprecated This is kind of an expert mode. Get access to the rowstart
+ * array, but read-only.
*
- * Use of this function is highly
- * deprecated. Use @p row_length and
- * @p column_number instead. Also, using
- * iterators may get you most of the
+ * Use of this function is highly deprecated. Use @p row_length and @p
+ * column_number instead. Also, using iterators may get you most of the
* information you may want.
*
- * Though the return value is declared
- * <tt>const</tt>, you should be aware that it
- * may change if you call any nonconstant
- * function of objects which operate on
- * it.
+ * Though the return value is declared <tt>const</tt>, you should be aware
+ * that it may change if you call any nonconstant function of objects which
+ * operate on it.
*
- * You should use this interface very
- * carefully and only if you are absolutely
- * sure to know what you do. You should
- * also note that the structure of these
- * arrays may change over time.
- * If you change the layout yourself, you
- * should also rename this function to
- * avoid programs relying on outdated
- * information!
+ * You should use this interface very carefully and only if you are
+ * absolutely sure to know what you do. You should also note that the
+ * structure of these arrays may change over time. If you change the layout
+ * yourself, you should also rename this function to avoid programs relying
+ * on outdated information!
*/
- inline const std::size_t *get_rowstart_indices () const;
+ inline const std::size_t *get_rowstart_indices () const DEAL_II_DEPRECATED;
/**
- * @deprecated. Use @p row_length and
- * @p column_number instead. Also, using
- * iterators may get you most of the
- * information you may want.
+ * @deprecated. Use @p row_length and @p column_number instead. Also, using
+ * iterators may get you most of the information you may want.
*
- * This is kind of an expert mode: get
- * access to the colnums array, but
+ * This is kind of an expert mode: get access to the colnums array, but
* readonly.
*
- * Though the return value is declared
- * <tt>const</tt>, you should be aware that it
- * may change if you call any nonconstant
- * function of objects which operate on
- * it.
+ * Though the return value is declared <tt>const</tt>, you should be aware
+ * that it may change if you call any nonconstant function of objects which
+ * operate on it.
*
- * You should use this interface very
- * carefully and only if you are absolutely
- * sure to know what you do. You should
- * also note that the structure of these
- * arrays may change over time.
- * If you change the layout yourself, you
- * should also rename this function to
- * avoid programs relying on outdated
- * information!
+ * You should use this interface very carefully and only if you are
+ * absolutely sure to know what you do. You should also note that the
+ * structure of these arrays may change over time. If you change the layout
+ * yourself, you should also rename this function to avoid programs relying
+ * on outdated information!
*/
- inline const unsigned int *get_column_numbers () const;
+ inline const unsigned int *get_column_numbers () const DEAL_II_DEPRECATED;
BOOST_SERIALIZATION_SPLIT_MEMBER()
/** @addtogroup Exceptions