.. _oneapi-mkl-sparse-init_matmat_descr:

oneapi::mkl::sparse::init_matmat_descr
======================================

Allocates and initializes a ``oneapi::mkl::sparse::matmat_descr_t`` object to default values.


.. contents::
    :local:
    :depth: 1

Description
***********

The ``oneapi::mkl::sparse::init_matmat_descr`` routine allocates and initializes the ``oneapi::mkl::sparse::matmat_descr_t`` object with default
values, otherwise it throws an exception.

.. note::
   Refer to :ref:`Exceptions <exceptions>` for a detailed description of the exceptions thrown.

A common usage model for the ``matmat`` descriptor is the following

.. code-block:: cpp

    using namespace oneapi::mkl;
    sparse::matmat_descr_t descr = NULL;
    sparse::init_matmat_descr(descr);

    // example descriptor for general
    // C = A * B^T
    sparse::matrix_view_descr viewA = sparse::matrix_view_descr::general;
    sparse::matrix_view_descr viewB = sparse::matrix_view_descr::general;
    sparse::matrix_view_descr viewC = sparse::matrix_view_descr::general;
    transpose opA = transpose::nontrans;
    transpose opB = transpose::trans;

    sparse::set_matmat_data(descr, viewA, opA, viewB, opB, viewC);

    // use descr in sparse::matmat() api

    sparse::release_matmat_descr(descr);


API
***

Syntax
------

.. code-block:: cpp

    namespace oneapi::mkl::sparse {
        void init_matmat_descr ( oneapi::mkl::sparse::matmat_descr_t *descr );
    }



Include Files
-------------

-  oneapi/mkl/spblas.hpp