File: GxB_Context_disengage.c

package info (click to toggle)
suitesparse 1%3A7.10.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 254,920 kB
  • sloc: ansic: 1,134,743; cpp: 46,133; makefile: 4,875; fortran: 2,087; java: 1,826; sh: 996; ruby: 725; python: 495; asm: 371; sed: 166; awk: 44
file content (46 lines) | stat: -rw-r--r-- 1,906 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
//------------------------------------------------------------------------------
// GxB_Context_disengage: disengage a Context for this user thread
//------------------------------------------------------------------------------

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

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

// If a NULL Context is provided or if the Context input parameter is
// GxB_CONTEXT_WORLD, then any current Context for this user thread is
// disengaged.  If a valid non-NULL Context is provided and it matches the
// current Context for this user thread, it is disengaged.  In all of these
// cases, GrB_SUCCESS is returned.  The user thread has no Context object and
// any subsequent calls to GraphBLAS functions will use the world Context,
// GxB_CONTEXT_WORLD.

// Error cases:
// If a non-NULL Context is provided but it is faulty in some way, then an
// error code is returned (GrB_INVALID_OBJECT or GrB_UNINITIALIZED_OBJECT).
// If a non-NULL Context is provided on input that doesn't match the current
// Context for this thread, then GrB_INVALID_VALUE is returned.
// If an error code is returned, the current Context for this user thread is
// unmodified.

#include "GB.h"

GrB_Info GxB_Context_disengage      // disengage a Context
(
    GxB_Context Context             // Context to disengage
)
{ 

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

    GB_RETURN_IF_FAULTY (Context) ;

    //--------------------------------------------------------------------------
    // disengage the Context
    //--------------------------------------------------------------------------

    return (GB_Context_disengage (Context)) ;
}