1 /* Copyright 2007,2012 IPB, Universite de Bordeaux, INRIA & CNRS
2 **
3 ** This file is part of the Scotch software package for static mapping,
4 ** graph partitioning and sparse matrix ordering.
5 **
6 ** This software is governed by the CeCILL-C license under French law
7 ** and abiding by the rules of distribution of free software. You can
8 ** use, modify and/or redistribute the software under the terms of the
9 ** CeCILL-C license as circulated by CEA, CNRS and INRIA at the following
10 ** URL: "http://www.cecill.info".
11 **
12 ** As a counterpart to the access to the source code and rights to copy,
13 ** modify and redistribute granted by the license, users are provided
14 ** only with a limited warranty and the software's author, the holder of
15 ** the economic rights, and the successive licensors have only limited
16 ** liability.
17 **
18 ** In this respect, the user's attention is drawn to the risks associated
19 ** with loading, using, modifying and/or developing or reproducing the
20 ** software by the user in light of its specific status of free software,
21 ** that may mean that it is complicated to manipulate, and that also
22 ** therefore means that it is reserved for developers and experienced
23 ** professionals having in-depth computer knowledge. Users are therefore
24 ** encouraged to load and test the software's suitability as regards
25 ** their requirements in conditions enabling the security of their
26 ** systems and/or data to be ensured and, more generally, to use and
27 ** operate it in the same conditions as regards security.
28 **
29 ** The fact that you are presently reading this means that you have had
30 ** knowledge of the CeCILL-C license and that you accept its terms.
31 */
32 /************************************************************/
33 /**                                                        **/
34 /**   NAME       : library_dgraph_order_io.c               **/
35 /**                                                        **/
36 /**   AUTHOR     : Francois PELLEGRINI                     **/
37 /**                                                        **/
38 /**   FUNCTION   : This module is the API for the distri-  **/
39 /**                buted ordering I/O routines of the      **/
40 /**                libSCOTCH library.                      **/
41 /**                                                        **/
42 /**   DATES      : # Version 5.0  : from : 26 jul 2007     **/
43 /**                                 to     18 oct 2007     **/
44 /**                # Version 6.0  : from : 29 nov 2012     **/
45 /**                                 to     29 nov 2012     **/
46 /**                                                        **/
47 /************************************************************/
48 
49 /*
50 **  The defines and includes.
51 */
52 
53 #define LIBRARY
54 
55 #include "module.h"
56 #include "common.h"
57 #include "dgraph.h"
58 #include "dorder.h"
59 #include "ptscotch.h"
60 
61 /************************************/
62 /*                                  */
63 /* These routines are the C API for */
64 /* the distributed ordering         */
65 /* handling routines.               */
66 /*                                  */
67 /************************************/
68 
69 /*+ This routine saves to the given stream
70 *** the mapping data associated with the
71 *** given distributed ordering.
72 *** It returns:
73 *** - 0   : on success.
74 *** - !0  : on error.
75 +*/
76 
77 int
SCOTCH_dgraphOrderSaveMap(const SCOTCH_Dgraph * const grafptr,const SCOTCH_Dordering * const ordeptr,FILE * const stream)78 SCOTCH_dgraphOrderSaveMap (
79 const SCOTCH_Dgraph * const     grafptr,          /*+ Graph to order   +*/
80 const SCOTCH_Dordering * const  ordeptr,          /*+ Ordering to save +*/
81 FILE * const                    stream)           /*+ Output stream    +*/
82 {
83   return (dorderSaveMap ((Dorder *) ordeptr, (Dgraph *) grafptr, stream));
84 }
85 
86 /*+ This routine saves to the given stream
87 *** the separator tree data associated with
88 *** the given distributed ordering.
89 *** It returns:
90 *** - 0   : on success.
91 *** - !0  : on error.
92 +*/
93 
94 int
SCOTCH_dgraphOrderSaveTree(const SCOTCH_Dgraph * const grafptr,const SCOTCH_Dordering * const ordeptr,FILE * const stream)95 SCOTCH_dgraphOrderSaveTree (
96 const SCOTCH_Dgraph * const     grafptr,          /*+ Graph to order   +*/
97 const SCOTCH_Dordering * const  ordeptr,          /*+ Ordering to save +*/
98 FILE * const                    stream)           /*+ Output stream    +*/
99 {
100   return (dorderSaveTree ((Dorder *) ordeptr, (Dgraph *) grafptr, stream));
101 }
102