TPIE

11a2c2d
tpie.h
Go to the documentation of this file.
1 // -*- mode: c++; tab-width: 4; indent-tabs-mode: t; eval: (progn (c-set-style "stroustrup") (c-set-offset 'innamespace 0)); -*-
2 // vi:set ts=4 sts=4 sw=4 noet :
3 // Copyright 2011, The TPIE development team
4 //
5 // This file is part of TPIE.
6 //
7 // TPIE is free software: you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License as published by the
9 // Free Software Foundation, either version 3 of the License, or (at your
10 // option) any later version.
11 //
12 // TPIE is distributed in the hope that it will be useful, but WITHOUT ANY
13 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
15 // License for more details.
16 //
17 // You should have received a copy of the GNU Lesser General Public License
18 // along with TPIE. If not, see <http://www.gnu.org/licenses/>
19 #ifndef __TPIE_TPIE_H__
20 #define __TPIE_TPIE_H__
21 
22 #include <tpie/tpie_export.h>
23 #include <tpie/config.h>
24 #include <tpie/types.h>
25 #include <tpie/flags.h>
26 
30 
34 
35 namespace tpie {
36 
40 enum subsystem {
53  STREAMS=64,
55  TEMPFILE=256,
61 };
62 
63 TPIE_DECLARE_OPERATORS_FOR_FLAGS(subsystem)
64 
65 TPIE_EXPORT void tpie_init(flags<subsystem> subsystems=ALL);
70 
77 TPIE_EXPORT void tpie_finish(flags<subsystem> subsystems=ALL);
78 
86 TPIE_EXPORT memory_size_type get_block_size();
87 
93 TPIE_EXPORT void set_block_size(memory_size_type block_size);
94 
95 } //namespace tpie
96 
97 #endif //__TPIE_TPIE_H__
tpie::ALL
@ ALL
Alias for all default subsystems.
Definition: tpie.h:60
tpie::FILE_MANAGER
@ FILE_MANAGER
Needed for working with files and implicitly by all TPIE algorithm and data structure implementations...
Definition: tpie.h:58
types.h
tpie::PROGRESS
@ PROGRESS
Progress tracking.
Definition: tpie.h:47
tpie::set_block_size
TPIE_EXPORT void set_block_size(memory_size_type block_size)
Set the TPIE block size.
tpie::DEFAULT_LOGGING
@ DEFAULT_LOGGING
TPIE logging framework.
Definition: tpie.h:45
tpie::TEMPFILE
@ TEMPFILE
Generate temporary files.
Definition: tpie.h:55
tpie::tpie_init
TPIE_EXPORT void tpie_init(flags< subsystem > subsystems=ALL)
Initialize the given subsystems of TPIE.
tpie::STREAMS
@ STREAMS
Enable support for streams.
Definition: tpie.h:53
tpie::MEMORY_MANAGER
@ MEMORY_MANAGER
Needed for tpie_new and tpie_delete and implicitly needed by all TPIE algorithm and data structure im...
Definition: tpie.h:43
tpie::CAPTURE_FRACTIONS
@ CAPTURE_FRACTIONS
Capture fractions.
Definition: tpie.h:51
tpie::subsystem
subsystem
Subsystems of TPIE.
Definition: tpie.h:40
tpie::get_block_size
TPIE_EXPORT memory_size_type get_block_size()
Get the TPIE block size.
tpie::JOB_MANAGER
@ JOB_MANAGER
Job manager, for job.h and the parallel quick sort.
Definition: tpie.h:49
tpie::tpie_finish
TPIE_EXPORT void tpie_finish(flags< subsystem > subsystems=ALL)
Deinitialize the given subsystems of TPIE.
tpie
Definition: access_type.h:26