ALP User Documentation  0.8.preview
Algebraic Programming User Documentation
init.hpp
Go to the documentation of this file.
1 
2 /*
3  * Copyright 2021 Huawei Technologies Co., Ltd.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
27 #ifndef _H_GRB_INIT_BASE
28 #define _H_GRB_INIT_BASE
29 
30 #include <graphblas/rc.hpp>
31 
32 #include "config.hpp"
33 
34 
35 namespace grb {
36 
144  template< enum Backend backend = config::default_backend >
145  RC init( const size_t s, const size_t P, void * const implementation_data ) {
146  (void) s;
147  (void) P;
148  (void) implementation_data;
149  return PANIC;
150  }
151 
171  template< enum Backend backend = config::default_backend >
172  RC init() {
173  return grb::init< backend >( 0, 1, nullptr );
174  }
175 
209  template< enum Backend backend = config::default_backend >
211  return PANIC;
212  }
213 
214 } // namespace grb
215 
216 #endif // end _H_GRB_INIT_BASE
217 
Defines the ALP error codes.
RC
Return codes of ALP primitives.
Definition: rc.hpp:47
RC init(const size_t s, const size_t P, void *const implementation_data)
Initialises the calling user process.
Definition: init.hpp:145
The ALP/GraphBLAS namespace.
Definition: graphblas.hpp:477
Generic fatal error code.
Definition: rc.hpp:68
Defines both configuration parameters effective for all backends, as well as defines structured ways ...
RC finalize()
Finalises an ALP/GraphBLAS context opened by the last call to grb::init.
Definition: init.hpp:210