ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_sampleWeight::setReweight Interface Reference

Generate and return a reweighting of the input weight vector, such that the sequence represented by output reweight is the refined (skipped by the amount skip) version of the sequence represented by the input weight.
More...

Detailed Description

Generate and return a reweighting of the input weight vector, such that the sequence represented by output reweight is the refined (skipped by the amount skip) version of the sequence represented by the input weight.

The following examples illustrate the specific functioning of this generic interface:

skip: 1
Weight: 5, 0, 1, 3, 1
RefinedWeight: 5, 0, 1, 3, 1
skip: 2
Weight: 5, 0, 1, 3, 1
RefinedWeight: 3, 0, 0, 2, 0
skip: 3
Weight: 5, 0, 1, 3, 1
RefinedWeight: 2, 0, 0, 1, 1
Parameters
[in,out]weight: The input/output contiguous array of shape (:) of
  1. type integer of default kind IK,
  2. type integer of kind any supported by the processor (e.g., IK, IK8, IK16, IK32, or IK64),
  3. type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128),
containing the weights that are to be reweighted (refined).
On output, each element of weight is reset to the refined value (or zero if the element does not contribute to the refinement).
Non-positive values are allowed, but ignored by definition and reset to zero in the output reweight.
[in]skip: The input scalar of the same type and kind as the input weight, representing the size of the skip in the sequence whose weight is given as input.
If the input weight is of type integer of default kind IK, then skip can be also of type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128).


Possible calling interfaces

reweight(1 : size(weight)) = setReweight(weight, skip)
Generate and return a reweighting of the input weight vector, such that the sequence represented by o...
This module contains the types, classes, and procedures relevant to weights of random samples.
Warning
The condition 0 < skip must hold.
These conditions are verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.
The pure procedure(s) documented herein become impure when the ParaMonte library is compiled with preprocessor macro CHECK_ENABLED=1.
By default, these procedures are pure in release build and impure in debug and testing builds.
Developer Remark:
The term reweight here stands for refined weight.
See also
getReweight
setReweight
getRefined
setRefined
getCompact
setCompact
getVerbose


Example usage

1program example
2
3 use pm_kind, only: SK, IK, LK
5 use pm_distUnif, only: getUnifRand
6 use pm_io, only: display_type
7
8 implicit none
9
10 type(display_type) :: disp
11 integer(IK) :: lenwei, itry, ntry = 10
12 disp = display_type(file = "main.out.F90")
13
14 block
15 use pm_kind, only: IKG => IK ! all processor kinds are supported.
16 integer(IKG), allocatable :: weight(:)
17 integer(IKG) :: skip
18 do itry = 1, ntry
19 call disp%show("lenwei = getUnifRand(0, 9); skip = getUnifRand(1, 4)")
20 lenwei = getUnifRand(0, 9); skip = getUnifRand(1, 4)
21 call disp%show("lenwei")
22 call disp%show( lenwei )
23 call disp%show("skip")
24 call disp%show( skip )
25 call disp%show("weight = getUnifRand(-1, 9, lenwei)")
26 weight = getUnifRand(-1, 9, lenwei)
27 call disp%show("weight")
28 call disp%show( weight )
29 call disp%show("call setReweight(weight, skip)")
30 call setReweight(weight, skip)
31 call disp%show("weight")
32 call disp%show( weight )
33 call disp%skip()
34 end do
35 end block
36
37 block
38 use pm_kind, only: RKG => RKS ! all processor kinds are supported.
39 real(RKG), allocatable :: weight(:)
40 real(RKG) :: skip
41 do itry = 1, ntry
42 call disp%show("lenwei = getUnifRand(0, 9); skip = getUnifRand(.1_RKG, 4._RKG)")
43 lenwei = getUnifRand(0, 9); skip = getUnifRand(.1_RKG, 4._RKG)
44 call disp%show("lenwei")
45 call disp%show( lenwei )
46 call disp%show("skip")
47 call disp%show( skip )
48 call disp%show("weight = getUnifRand(-1._RKG, 9._RKG, lenwei)")
49 weight = getUnifRand(-1._RKG, 9._RKG, lenwei)
50 call disp%show("weight")
51 call disp%show( weight )
52 call disp%show("call setReweight(weight, skip)")
53 call setReweight(weight, skip)
54 call disp%show("weight")
55 call disp%show( weight )
56 call disp%skip()
57 end do
58 end block
59
60end program example
Generate and return a scalar or a contiguous array of rank 1 of length s1 of randomly uniformly distr...
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
This module contains classes and procedures for computing various statistical quantities related to t...
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539
integer, parameter RKS
The single-precision real kind in Fortran mode. On most platforms, this is an 32-bit real kind.
Definition: pm_kind.F90:567
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler
1#!/usr/bin/env sh
2rm main.exe
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example Windows Batch compile command via Intel ifort compiler
1del main.exe
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler
1#!/usr/bin/env sh
2rm main.exe
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example output
1lenwei = getUnifRand(0, 9); skip = getUnifRand(1, 4)
2lenwei
3+5
5+2
6weight = getUnifRand(-1, 9, lenwei)
7weight
8+0, -1, +2, +2, +5
9call setReweight(weight, skip)
10weight
11+0, +0, +1, +1, +2
12
13lenwei = getUnifRand(0, 9); skip = getUnifRand(1, 4)
14lenwei
15+4
16skip
17+3
18weight = getUnifRand(-1, 9, lenwei)
19weight
20+0, +1, +2, +6
21call setReweight(weight, skip)
22weight
23+0, +0, +1, +2
24
25lenwei = getUnifRand(0, 9); skip = getUnifRand(1, 4)
26lenwei
27+8
28skip
29+3
30weight = getUnifRand(-1, 9, lenwei)
31weight
32+6, +7, +6, +7, +9, +5, +8, +0
33call setReweight(weight, skip)
34weight
35+2, +2, +2, +2, +3, +2, +3, +0
36
37lenwei = getUnifRand(0, 9); skip = getUnifRand(1, 4)
38lenwei
39+0
40skip
41+2
42weight = getUnifRand(-1, 9, lenwei)
43weight
44
45call setReweight(weight, skip)
46weight
47
48
49lenwei = getUnifRand(0, 9); skip = getUnifRand(1, 4)
50lenwei
51+8
52skip
53+1
54weight = getUnifRand(-1, 9, lenwei)
55weight
56+9, +8, +1, +2, +0, +0, +4, +3
57call setReweight(weight, skip)
58weight
59+9, +8, +1, +2, +0, +0, +4, +3
60
61lenwei = getUnifRand(0, 9); skip = getUnifRand(1, 4)
62lenwei
63+2
64skip
65+3
66weight = getUnifRand(-1, 9, lenwei)
67weight
68+6, +5
69call setReweight(weight, skip)
70weight
71+2, +1
72
73lenwei = getUnifRand(0, 9); skip = getUnifRand(1, 4)
74lenwei
75+5
76skip
77+4
78weight = getUnifRand(-1, 9, lenwei)
79weight
80+6, -1, +2, +3, +7
81call setReweight(weight, skip)
82weight
83+1, +0, +1, +0, +2
84
85lenwei = getUnifRand(0, 9); skip = getUnifRand(1, 4)
86lenwei
87+2
88skip
89+2
90weight = getUnifRand(-1, 9, lenwei)
91weight
92+5, +3
93call setReweight(weight, skip)
94weight
95+2, +2
96
97lenwei = getUnifRand(0, 9); skip = getUnifRand(1, 4)
98lenwei
99+1
100skip
101+1
102weight = getUnifRand(-1, 9, lenwei)
103weight
104+2
105call setReweight(weight, skip)
106weight
107+2
108
109lenwei = getUnifRand(0, 9); skip = getUnifRand(1, 4)
110lenwei
111+7
112skip
113+1
114weight = getUnifRand(-1, 9, lenwei)
115weight
116+3, +7, +4, +2, +6, +1, +9
117call setReweight(weight, skip)
118weight
119+3, +7, +4, +2, +6, +1, +9
120
121lenwei = getUnifRand(0, 9); skip = getUnifRand(.1_RKG, 4._RKG)
122lenwei
123+5
124skip
125+0.220872641
126weight = getUnifRand(-1._RKG, 9._RKG, lenwei)
127weight
128+4.14014387, -0.105193615, +8.60605335, +7.47782516, +6.69191599
129call setReweight(weight, skip)
130weight
131+18.0000000, +0.00000000, +39.0000000, +34.0000000, +30.0000000
132
133lenwei = getUnifRand(0, 9); skip = getUnifRand(.1_RKG, 4._RKG)
134lenwei
135+5
136skip
137+0.225829124
138weight = getUnifRand(-1._RKG, 9._RKG, lenwei)
139weight
140+2.38355923, +7.83885431, +6.73765039, +3.15318584, +6.49344349
141call setReweight(weight, skip)
142weight
143+10.0000000, +35.0000000, +30.0000000, +14.0000000, +28.0000000
144
145lenwei = getUnifRand(0, 9); skip = getUnifRand(.1_RKG, 4._RKG)
146lenwei
147+9
148skip
149+3.43925023
150weight = getUnifRand(-1._RKG, 9._RKG, lenwei)
151weight
152+0.854147375, +3.90060067, +0.607099116, +0.714828551, +6.80619431, +5.27167082, +4.56221390, -0.855189323, +3.49012446
153call setReweight(weight, skip)
154weight
155+0.00000000, +1.00000000, +0.00000000, +0.00000000, +2.00000000, +2.00000000, +1.00000000, +0.00000000, +1.00000000
156
157lenwei = getUnifRand(0, 9); skip = getUnifRand(.1_RKG, 4._RKG)
158lenwei
159+4
160skip
161+2.09610534
162weight = getUnifRand(-1._RKG, 9._RKG, lenwei)
163weight
164-0.277421474E-1, +8.49165154, +3.33932495, -0.246979952
165call setReweight(weight, skip)
166weight
167+0.00000000, +4.00000000, +1.00000000, +0.00000000
168
169lenwei = getUnifRand(0, 9); skip = getUnifRand(.1_RKG, 4._RKG)
170lenwei
171+2
172skip
173+1.32901442
174weight = getUnifRand(-1._RKG, 9._RKG, lenwei)
175weight
176+0.376719475, +3.86153650
177call setReweight(weight, skip)
178weight
179+0.00000000, +3.00000000
180
181lenwei = getUnifRand(0, 9); skip = getUnifRand(.1_RKG, 4._RKG)
182lenwei
183+1
184skip
185+3.22102714
186weight = getUnifRand(-1._RKG, 9._RKG, lenwei)
187weight
188+2.17360163
189call setReweight(weight, skip)
190weight
191+0.00000000
192
193lenwei = getUnifRand(0, 9); skip = getUnifRand(.1_RKG, 4._RKG)
194lenwei
195+2
196skip
197+2.90823150
198weight = getUnifRand(-1._RKG, 9._RKG, lenwei)
199weight
200+4.00301790, +4.18511581
201call setReweight(weight, skip)
202weight
203+1.00000000, +1.00000000
204
205lenwei = getUnifRand(0, 9); skip = getUnifRand(.1_RKG, 4._RKG)
206lenwei
207+0
208skip
209+1.06205416
210weight = getUnifRand(-1._RKG, 9._RKG, lenwei)
211weight
212
213call setReweight(weight, skip)
214weight
215
216
217lenwei = getUnifRand(0, 9); skip = getUnifRand(.1_RKG, 4._RKG)
218lenwei
219+9
220skip
221+3.15131688
222weight = getUnifRand(-1._RKG, 9._RKG, lenwei)
223weight
224+2.59372091, -0.680048227, +4.71636581, +5.64372396, -0.260465503, +0.301268995, +3.44542789, +3.22588921, +6.24902534
225call setReweight(weight, skip)
226weight
227+0.00000000, +0.00000000, +2.00000000, +2.00000000, +0.00000000, +0.00000000, +1.00000000, +1.00000000, +2.00000000
228
229lenwei = getUnifRand(0, 9); skip = getUnifRand(.1_RKG, 4._RKG)
230lenwei
231+3
232skip
233+1.19464731
234weight = getUnifRand(-1._RKG, 9._RKG, lenwei)
235weight
236-0.378637075, +0.454802096, +0.282009840E-1
237call setReweight(weight, skip)
238weight
239+0.00000000, +0.00000000, +0.00000000
240
241
Test:
test_pm_sampleWeight


Final Remarks


If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

  1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
  2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Author:
Amir Shahmoradi, Saturday 1:48 AM, August 20, 2016, Institute for Computational Engineering and Sciences, UT Austin, TX

Definition at line 640 of file pm_sampleWeight.F90.


The documentation for this interface was generated from the following file: