//------------------------------------------------------------------------------
// GB_dup: make a deep copy of a matrix
//------------------------------------------------------------------------------

// SuiteSparse:GraphBLAS, Timothy A. Davis, (c) 2017-2025, All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

//------------------------------------------------------------------------------

// C = A, making a deep copy.  Not user-callable; this function does the work
// for user-callable functions GrB_*_dup.

// if numeric is false, C->x is allocated but not initialized.

// Pending work in A is copied into C; it is not finished.

// There is little use for the following feature, but (*Chandle) and A might be
// identical, with GrB_dup (&A, A).  The input matrix A will be lost, and will
// result in a memory leak, unless the user application does the following
// (which is valid and memory-leak free):

//      B = A ;
//      GrB_dup (&A, A) ;
//      GrB_free (&A) ;
//      GrB_free (&B) ;

// A is the new copy and B is the old copy.  Each should be freed when done.

// The p/j/i integers in the output C are identical to the p/j/i ints in A.

#include "GB.h"

GrB_Info GB_dup             // make an exact copy of a matrix
(
    GrB_Matrix *Chandle,    // handle of output matrix to create
    const GrB_Matrix A,     // input matrix to copy
    const int header_arena,
    const int data_arena,
    GB_Werk Werk
)
{ 

    //--------------------------------------------------------------------------
    // check inputs
    //--------------------------------------------------------------------------

    GrB_Info info ;
    ASSERT (Chandle != NULL) ;
    ASSERT_MATRIX_OK (A, "A to duplicate", GB0) ;
    (*Chandle) = NULL ;

    //--------------------------------------------------------------------------
    // C = A
    //--------------------------------------------------------------------------

    GB_BURBLE_MATRIX (A, "(%sdup) ", A->iso ? "iso " : "") ;
    return (GB_dup_worker (Chandle, A->iso, A, /* numeric: */ true,
        /* C->type is the same as A->type: */ NULL,
        /* C has the same ints as A: */ A->p_is_32, A->j_is_32, A->i_is_32,
        header_arena, data_arena, Werk)) ;
}

