Depsgraph: New dependency graph integration commit
[blender.git] / source / blender / depsgraph / intern / depsgraph_queue.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2013 Blender Foundation.
19  * All rights reserved.
20  *
21  * Original Author: Joshua Leung
22  * Contributor(s): None Yet
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  *
26  * Defines for special queue type for use in Depsgraph traversals
27  */
28
29 #ifndef __DEPSGRAPH_QUEUE_H__
30 #define __DEPSGRAPH_QUEUE_H__
31
32 struct DepsNode;
33
34 struct Heap;
35 struct GHash;
36
37 /* *********************************************** */
38 /* Dependency Graph Traversal Queue
39  *
40  * There are two parts to this:
41  * a) "Pending" Nodes - This part contains the set of nodes
42  *    which are related to those which have been visited
43  *    previously, but are not yet ready to actually be visited.
44  * b) "Scheduled" Nodes - These are the nodes whose ancestors
45  *    have all been evaluated already, which means that any
46  *    or all of them can be picked (in practically in order) to
47  *    be visited immediately.
48  *
49  * Internally, the queue makes sure that each node in the graph
50  * only gets added to the queue once. This is because there can
51  * be multiple inlinks to each node given the way that the relations
52  * work.
53  */
54
55 /* Depsgraph Queue Type */
56 typedef struct DepsgraphQueue {
57         /* Pending */
58         struct Heap *pending_heap;         /* (valence:int, DepsNode*) */
59         struct GHash *pending_hash;        /* (DepsNode* : HeapNode*>) */
60
61         /* Ready to be visited - fifo */
62         struct Heap *ready_heap;           /* (idx:int, DepsNode*) */
63
64         /* Size/Order counts */
65         size_t idx;                        /* total number of nodes which are/have been ready so far (including those already visited) */
66         size_t tot;                        /* total number of nodes which have passed through queue; mainly for debug */
67 } DepsgraphQueue;
68
69 /* ************************** */
70 /* Depsgraph Queue Operations */
71
72 /* Data management */
73 DepsgraphQueue *DEG_queue_new(void);
74 void DEG_queue_free(DepsgraphQueue *q);
75
76 /* Statistics */
77 size_t DEG_queue_num_pending(DepsgraphQueue *q);
78 size_t DEG_queue_num_ready(DepsgraphQueue *q);
79
80 size_t DEG_queue_size(DepsgraphQueue *q);
81 bool DEG_queue_is_empty(DepsgraphQueue *q);
82
83 /* Operations */
84 void DEG_queue_push(DepsgraphQueue *q, void *dnode, float cost = 0.0f);
85 void *DEG_queue_pop(DepsgraphQueue *q);
86
87 #endif  /* DEPSGRAPH_QUEUE_H */