File: background.gd

package info (click to toggle)
gap-io 4.4.6%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 740 kB
  • ctags: 106
  • sloc: xml: 2,857; ansic: 2,823; sh: 38; makefile: 35
file content (140 lines) | stat: -rw-r--r-- 4,631 bytes parent folder | download | duplicates (4)
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
#############################################################################
##
##  background.gd               GAP 4 package IO
##                                                           Max Neunhoeffer
##
##  Copyright (C) 2006-2011 by Max Neunhoeffer
##  This file is free software, see license information at the end.
##
##  This file contains declarations for background processes using fork.
##

# The types for background jobs by fork:

BindGlobal("BackgroundJobsFamily", NewFamily("BackgroundJobsFamily"));

DeclareCategory("IsBackgroundJob",
                IsComponentObjectRep and IsAttributeStoringRep);
DeclareRepresentation("IsBackgroundJobByFork", IsBackgroundJob,
  ["pid", "childtoparent", "parenttochild", "result",
   "terminated"]);

BindGlobal("BGJobByForkType",
           NewType(BackgroundJobsFamily, IsBackgroundJobByFork));


# Some helpers for times:

DeclareGlobalFunction("DifferenceTimes");
DeclareGlobalFunction("CompareTimes");

# The constructor:

DeclareOperation("BackgroundJobByFork", [IsFunction, IsObject]);
DeclareOperation("BackgroundJobByFork", [IsFunction, IsObject, IsRecord]);
DeclareGlobalVariable("BackgroundJobByForkOptions");
DeclareGlobalFunction("BackgroundJobByForkChild");


# The operations/attributes/properties:

DeclareOperation("IsIdle", [IsBackgroundJob]);
DeclareOperation("HasTerminated", [IsBackgroundJob]);
DeclareOperation("WaitUntilIdle", [IsBackgroundJob]);
DeclareOperation("Kill", [IsBackgroundJob]);
DeclareOperation("Pickup", [IsBackgroundJob]);
DeclareOperation("Submit", [IsBackgroundJob, IsObject]);


# Parallel skeletons:

DeclareGlobalVariable("ParTakeFirstResultByForkOptions");

DeclareOperation("ParTakeFirstResultByFork", [IsList, IsList]);
DeclareOperation("ParTakeFirstResultByFork", [IsList, IsList, IsRecord]);
# Arguments are:
#   list of job functions
#   list of argument lists
#   options record

DeclareGlobalVariable("ParDoByForkOptions");

DeclareOperation( "ParDoByFork", [IsList, IsList]);
DeclareOperation( "ParDoByFork", [IsList, IsList, IsRecord]);
# Arguments are:
#   list of job functions
#   list of argument lists
#   options record

DeclareGlobalFunction("ParMapReduceWorker");
DeclareGlobalVariable("ParMapReduceByForkOptions");

DeclareOperation("ParMapReduceByFork",
  [IsList, IsFunction, IsFunction, IsRecord]);
# Arguments are:
#   list to work on
#   map function
#   reduce function (taking two arguments)
#   options record

DeclareGlobalFunction("ParListWorker");
DeclareGlobalVariable("ParListByForkOptions");

DeclareOperation("ParListByFork",
  [IsList, IsFunction, IsRecord]);
# Arguments are:
#   list to work on
#   map function
#   options record


# The types for worker farms by fork:

BindGlobal("WorkerFarmsFamily", NewFamily("WorkerFarmsFamily"));

DeclareCategory("IsWorkerFarm",
                IsComponentObjectRep and IsAttributeStoringRep);
DeclareRepresentation("IsWorkerFarmByFork", IsWorkerFarm,
  ["jobs", "inqueue", "outqueue", "whodoeswhat"]);


BindGlobal("WorkerFarmByForkType",
           NewType(WorkerFarmsFamily, IsWorkerFarmByFork));

DeclareGlobalVariable("ParWorkerFarmByForkOptions");

DeclareOperation("ParWorkerFarmByFork", [IsFunction, IsRecord]);
# Arguments are:
#   worker function
#   options record
#
# This creates a new object of type "IsWorkerFarmByFork".

DeclareOperation("DoQueues", [IsWorkerFarmByFork, IsBool]);
DeclareOperation("Kill", [IsWorkerFarmByFork]);
DeclareOperation("Submit", [IsWorkerFarmByFork, IsList]);
DeclareOperation("IsIdle", [IsWorkerFarmByFork]);
DeclareOperation("Pickup", [IsWorkerFarmByFork]);

# Semantics:
#   Starts some background jobs, maintains an "in" and an "out" queue.
#   DoQueues feeds idle jobs from the input queue and gets results
#   from them for the output queue.
#   Kill and IsIdle work on all workers at the same time. Submit queues
#   new jobs to the input queue and Pickup fetches all from the current
#   output queue (pairs of the form [arglist,result]).

##
##  This program is free software: you can redistribute it and/or modify
##  it under the terms of the GNU General Public License as published by
##  the Free Software Foundation, either version 3 of the License, or
##  (at your option) any later version.
##
##  This program is distributed in the hope that it will be useful,
##  but WITHOUT ANY WARRANTY; without even the implied warranty of
##  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
##  GNU General Public License for more details.
##
##  You should have received a copy of the GNU General Public License
##  along with this program.  If not, see <http://www.gnu.org/licenses/>.
##