%%% -*- Mode: Prolog; -*- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % $Date: 2010-09-28 21:04:43 +0200 (Tue, 28 Sep 2010) $ % $Revision: 4838 $ % % This file is part of ProbLog % http://dtai.cs.kuleuven.be/problog % % ProbLog was developed at Katholieke Universiteit Leuven % % Copyright 2008, 2009, 2010 % Katholieke Universiteit Leuven % % Main authors of this file: % Bernd Gutmann, Theofrastos Mantadelis % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % Artistic License 2.0 % % Copyright (c) 2000-2006, The Perl Foundation. % % Everyone is permitted to copy and distribute verbatim copies of this % license document, but changing it is not allowed. Preamble % % This license establishes the terms under which a given free software % Package may be copied, modified, distributed, and/or % redistributed. The intent is that the Copyright Holder maintains some % artistic control over the development of that Package while still % keeping the Package available as open source and free software. % % You are always permitted to make arrangements wholly outside of this % license directly with the Copyright Holder of a given Package. If the % terms of this license do not permit the full use that you propose to % make of the Package, you should contact the Copyright Holder and seek % a different licensing arrangement. Definitions % % "Copyright Holder" means the individual(s) or organization(s) named in % the copyright notice for the entire Package. % % "Contributor" means any party that has contributed code or other % material to the Package, in accordance with the Copyright Holder's % procedures. % % "You" and "your" means any person who would like to copy, distribute, % or modify the Package. % % "Package" means the collection of files distributed by the Copyright % Holder, and derivatives of that collection and/or of those files. A % given Package may consist of either the Standard Version, or a % Modified Version. % % "Distribute" means providing a copy of the Package or making it % accessible to anyone else, or in the case of a company or % organization, to others outside of your company or organization. % % "Distributor Fee" means any fee that you charge for Distributing this % Package or providing support for this Package to another party. It % does not mean licensing fees. % % "Standard Version" refers to the Package if it has not been modified, % or has been modified only in ways explicitly requested by the % Copyright Holder. % % "Modified Version" means the Package, if it has been changed, and such % changes were not explicitly requested by the Copyright Holder. % % "Original License" means this Artistic License as Distributed with the % Standard Version of the Package, in its current version or as it may % be modified by The Perl Foundation in the future. % % "Source" form means the source code, documentation source, and % configuration files for the Package. % % "Compiled" form means the compiled bytecode, object code, binary, or % any other form resulting from mechanical transformation or translation % of the Source form. % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % Permission for Use and Modification Without Distribution % % (1) You are permitted to use the Standard Version and create and use % Modified Versions for any purpose without restriction, provided that % you do not Distribute the Modified Version. % % Permissions for Redistribution of the Standard Version % % (2) You may Distribute verbatim copies of the Source form of the % Standard Version of this Package in any medium without restriction, % either gratis or for a Distributor Fee, provided that you duplicate % all of the original copyright notices and associated disclaimers. At % your discretion, such verbatim copies may or may not include a % Compiled form of the Package. % % (3) You may apply any bug fixes, portability changes, and other % modifications made available from the Copyright Holder. The resulting % Package will still be considered the Standard Version, and as such % will be subject to the Original License. % % Distribution of Modified Versions of the Package as Source % % (4) You may Distribute your Modified Version as Source (either gratis % or for a Distributor Fee, and with or without a Compiled form of the % Modified Version) provided that you clearly document how it differs % from the Standard Version, including, but not limited to, documenting % any non-standard features, executables, or modules, and provided that % you do at least ONE of the following: % % (a) make the Modified Version available to the Copyright Holder of the % Standard Version, under the Original License, so that the Copyright % Holder may include your modifications in the Standard Version. (b) % ensure that installation of your Modified Version does not prevent the % user installing or running the Standard Version. In addition, the % modified Version must bear a name that is different from the name of % the Standard Version. (c) allow anyone who receives a copy of the % Modified Version to make the Source form of the Modified Version % available to others under (i) the Original License or (ii) a license % that permits the licensee to freely copy, modify and redistribute the % Modified Version using the same licensing terms that apply to the copy % that the licensee received, and requires that the Source form of the % Modified Version, and of any works derived from it, be made freely % available in that license fees are prohibited but Distributor Fees are % allowed. % % Distribution of Compiled Forms of the Standard Version or % Modified Versions without the Source % % (5) You may Distribute Compiled forms of the Standard Version without % the Source, provided that you include complete instructions on how to % get the Source of the Standard Version. Such instructions must be % valid at the time of your distribution. If these instructions, at any % time while you are carrying out such distribution, become invalid, you % must provide new instructions on demand or cease further % distribution. If you provide valid instructions or cease distribution % within thirty days after you become aware that the instructions are % invalid, then you do not forfeit any of your rights under this % license. % % (6) You may Distribute a Modified Version in Compiled form without the % Source, provided that you comply with Section 4 with respect to the % Source of the Modified Version. % % Aggregating or Linking the Package % % (7) You may aggregate the Package (either the Standard Version or % Modified Version) with other packages and Distribute the resulting % aggregation provided that you do not charge a licensing fee for the % Package. Distributor Fees are permitted, and licensing fees for other % components in the aggregation are permitted. The terms of this license % apply to the use and Distribution of the Standard or Modified Versions % as included in the aggregation. % % (8) You are permitted to link Modified and Standard Versions with % other works, to embed the Package in a larger work of your own, or to % build stand-alone binary or bytecode versions of applications that % include the Package, and Distribute the result without restriction, % provided the result does not expose a direct interface to the Package. % % Items That are Not Considered Part of a Modified Version % % (9) Works (including, but not limited to, modules and scripts) that % merely extend or make use of the Package, do not, by themselves, cause % the Package to be a Modified Version. In addition, such works are not % considered parts of the Package itself, and are not subject to the % terms of this license. % % General Provisions % % (10) Any use, modification, and distribution of the Standard or % Modified Versions is governed by this Artistic License. By using, % modifying or distributing the Package, you accept this license. Do not % use, modify, or distribute the Package, if you do not accept this % license. % % (11) If your Modified Version has been derived from a Modified Version % made by someone other than you, you are nevertheless required to % ensure that your Modified Version complies with the requirements of % this license. % % (12) This license does not grant you the right to use any trademark, % service mark, tradename, or logo of the Copyright Holder. % % (13) This license includes the non-exclusive, worldwide, % free-of-charge patent license to make, have made, use, offer to sell, % sell, import and otherwise transfer the Package with respect to any % patent claims licensable by the Copyright Holder that are necessarily % infringed by the Package. If you institute patent litigation % (including a cross-claim or counterclaim) against any party alleging % that the Package constitutes direct or contributory patent % infringement, then this Artistic License to you shall terminate on the % date that such litigation is filed. % % (14) Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT % HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED % WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A % PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT % PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT % HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, % INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE % OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Statistics for ProbLog %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% :- module(variables, [problog_var_set/2, problog_var_set_once/2, problog_var_get/2, problog_var_is_set/1, problog_var_defined/4, problog_var_defined/1, problog_var_define/4, problog_var_define/3, problog_var_clear/1, problog_var_clear_all/0, problog_var_group/1, problog_timer_start/1, problog_timer_stop/2, problog_timer_pause/1, problog_timer_pause/2, problog_timer_resume/1, problog_time_out/4, problog_var_timer_start/1, problog_var_timer_resume/1, problog_var_timer_pause/1, problog_var_timer_stop/1, problog_var_timer_timeout/1, problog_var_time_out/4]). :- yap_flag(unknown,error). :- style_check(single_var). problog_var_set(Variable, Value):- ground(Variable), nonvar(Value), (recorded(problog_variables, stored(Variable, _Value), Ref) -> erase(Ref) ; true ), recordz(problog_variables, stored(Variable, Value), _Ref). problog_var_set_once(Variable, Value):- ground(Variable), nonvar(Value), (recorded(problog_variables, stored(Variable, _Value), __Ref) -> throw(problog_variable_already_set(problog_var_set_once(Variable, Value))) ; recordz(problog_variables, stored(Variable, Value), _Ref) ). problog_var_get(Variable, Value):- ((ground(Variable),recorded(problog_variables, stored(Variable, Value), _Ref)) -> true ; throw(problog_variable_not_set(problog_var_get(Variable, Value))) ). problog_var_is_set(Variable):- nonvar(Variable), recorded(problog_variables, stored(Variable, _Value), _Ref). problog_var_defined(Variable):- problog_var_defined(Variable, _Group, _Type, _Messages). problog_var_defined(Variable, Group, Type, Messages):- recorded(problog_variables, defined(Variable, Group, Type, Messages), _Ref). problog_var_defined(Variable, default, untyped, messages(Variable, ':', '')):- recorded(problog_variables, stored(Variable, _Value), _Ref), \+ recorded(problog_variables, defined(Variable, _Group, _Type, _Messages), _). problog_var_define(Variable, Group, Type):- problog_var_define(Variable, Group, Type, messages(Variable, ':', '')). problog_var_define(Variable, Group, Type, Messages):- recorded(problog_variables, defined(Variable, _Group, _Type, _Messages), _Ref), throw(problog_variable_already_defined(problog_var_define(Variable, Group, Type, Messages))). problog_var_define(Variable, Group, Type, Messages):- recordz(problog_variables, defined(Variable, Group, Type, Messages), _Ref), (recorded(problog_variables, group(Group), _) -> true ; recordz(problog_variables, group(Group), __Ref) ). problog_var_clear(Variable):- recorded(problog_variables, stored(Variable, _), Ref), erase(Ref). problog_var_clear_all:- recorded(problog_variables, stored(_, _), Ref), erase(Ref), fail. problog_var_clear_all. problog_var_group(Group):- recorded(problog_variables, group(Group), _). problog_var_group(default). %%% Migrated code from timers %%% % % This is more or less duplicate code now with timers. % We should decide if it stays here or it is a seperate module. % % modfications from module timers: works with records, stop stops a paused timer % should start resume a paused timer? Then no need for predicate resume... % problog_timer_start(Name) :- (recorded(problog_timer, timer(Name, _), _) -> throw(problog_timer_already_started(problog_timer_start(Name))); statistics(walltime, [StartTime, _]), recordz(problog_timer, timer(Name, StartTime), _) ). problog_timer_stop(Name, Duration) :- recorded(problog_timer, timer(Name, StartTime), Ref), erase(Ref), !, statistics(walltime, [StopTime, _]), Duration is StopTime - StartTime. problog_timer_stop(Name, Duration) :- (recorded(problog_timer, timer_paused(Name, Duration), Ref) -> erase(Ref) ; throw(problog_timer_not_started(problog_timer_stop(Name, Duration))) ). problog_timer_pause(Name) :- (recorded(problog_timer, timer(Name, StartTime), Ref) -> erase(Ref), statistics(walltime, [StopTime, _]), Duration is StopTime - StartTime, recordz(problog_timer, timer_paused(Name, Duration), _) ; throw(problog_timer_not_started(problog_timer_pause(Name))) ). problog_timer_pause(Name, Duration) :- (recorded(problog_timer, timer(Name, StartTime), Ref) -> erase(Ref), statistics(walltime, [StopTime, _]), Duration is StopTime - StartTime, recordz(problog_timer, timer_paused(Name, Duration), _) ; throw(problog_timer_not_started(problog_timer_pause(Name))) ). problog_timer_resume(Name):- (recorded(problog_timer, timer_paused(Name, Duration), Ref) -> erase(Ref), statistics(walltime, [ResumeTime, _]), CorrectedStartTime is ResumeTime - Duration, recordz(problog_timer, timer(Name, CorrectedStartTime), _) ; throw(problog_timer_not_paused(problog_timer_resume(Name))) ). %%% Syntactic sugar to make timer based variables %%% problog_var_timer_start(Variable):- problog_timer_start(Variable). problog_var_timer_resume(Variable):- problog_timer_resume(Variable). problog_var_timer_pause(Variable):- problog_timer_pause(Variable, Duration), problog_var_set(Variable, Duration). problog_var_timer_stop(Variable):- problog_timer_stop(Variable, Duration), problog_var_set(Variable, Duration). problog_var_timer_timeout(Variable):- problog_timer_stop(Variable, _Duration), problog_var_set(Variable, timeout). %%% This is possible for future use %%% :- use_module(library(timeout)). :- meta_predicate(problog_var_time_out(0, *, *, *)). :- meta_predicate(problog_time_out(0, *, *, *)). % % Problems with nesting, use with care % always succeeds returns Success = true/fail, Time = Msec taken/timeout % problog_var_time_out(M:Goal, TimeOut, Success, Variable):- problog_time_out(M:Goal, TimeOut, Success, Time), problog_var_set(Variable, Time). problog_time_out(M:Goal, TimeOut, Success, Time):- MSecs is TimeOut * 1000, problog_timer_start(time_measure), (time_out(M:Goal, MSecs, Result) -> problog_timer_stop(time_measure, Duration), (Result == success -> Success = true, Time = Duration ; Success = fail, Time = Result ) ; Success = fail, problog_timer_stop(time_measure, Time) ).