-
Notifications
You must be signed in to change notification settings - Fork 184
/
Copy pathstdlib_bitsets.fypp
2072 lines (1901 loc) · 81.7 KB
/
stdlib_bitsets.fypp
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#:include "common.fypp"
module stdlib_bitsets
!! Implements zero based bitsets of size up to `huge(0_int32)`.
!! The current code uses 64 bit integers to store the bits and uses all 64 bits.
!! The code assumes two's complement integers, and treats negative integers as
!! having the sign bit set.
!!([Specification](../page/specs/stdlib_bitsets.html))
use :: stdlib_kinds, only: &
bits_kind => int32, & ! If changed change also max_digits, and
block_kind => int64, & ! overflow_bits
int8, &
int16, &
int32, &
int64
use stdlib_optval, only : optval
use, intrinsic :: &
iso_fortran_env, only: &
error_unit
implicit none
private
integer(bits_kind), parameter :: &
block_size = bit_size(0_block_kind)
public :: max_digits, overflow_bits
integer, parameter :: &
max_digits = 10 ! bits_kind == int32
! max_digits = 19 ! bits_kind == int64
integer(bits_kind), parameter :: &
overflow_bits = 2_bits_kind**30/5 ! bits_kind == int32
! overflow_bits = 2_bits_kind**62/5 ! bits_kind == int64
integer(block_kind), parameter :: all_zeros = 0_block_kind
integer(block_kind), parameter :: all_ones = not(all_zeros)
character(*), parameter :: module_name = "STDLIB_BITSETS"
integer, parameter :: &
ia0 = iachar('0'), &
ia9 = iachar('9')
integer, parameter, public :: success = 0
!! Error flag indicating no errors
integer, parameter, public :: alloc_fault = 1
!! Error flag indicating a memory allocation failure
integer, parameter, public :: array_size_invalid_error = 2
!! Error flag indicating an invalid bits value
integer, parameter, public :: char_string_invalid_error = 3
!! Error flag indicating an invalid character string
integer, parameter, public :: char_string_too_large_error = 4
!! Error flag indicating a too large character string
integer, parameter, public :: char_string_too_small_error = 5
!! Error flag indicating a too small character string
integer, parameter, public :: eof_failure = 6
!! Error flag indicating unexpected End-of-File on a READ
integer, parameter, public :: index_invalid_error = 7
!! Error flag indicating an invalid index
integer, parameter, public :: integer_overflow_error = 8
!! Error flag indicating integer overflow
integer, parameter, public :: read_failure = 9
!! Error flag indicating failure of a READ statement
integer, parameter, public :: write_failure = 10
!! Error flag indicating a failure on a WRITE statement
public :: bits_kind
! Public constant
public :: &
bitset_type, &
bitset_large, &
bitset_64
! Public types
public :: &
assignment(=), &
and, &
and_not, &
bits, &
extract, &
operator(==), &
operator(/=), &
operator(>), &
operator(>=), &
operator(<), &
operator(<=), &
or, &
xor
!! Public procedures
public :: error_handler
type, abstract :: bitset_type
!! version: experimental
!!
!! Parent type for bitset_64 and bitset_large ([Specification](../page/specs/stdlib_bitsets.html#the-stdlib_bitsets-derived-types))
private
integer(bits_kind) :: num_bits
contains
procedure(all_abstract), deferred, pass(self) :: all
procedure(any_abstract), deferred, pass(self) :: any
procedure(bit_count_abstract), deferred, pass(self) :: bit_count
procedure, pass(self) :: bits
procedure(clear_bit_abstract), deferred, pass(self) :: clear_bit
procedure(clear_range_abstract), deferred, pass(self) :: clear_range
generic :: clear => clear_bit, clear_range
procedure(flip_bit_abstract), deferred, pass(self) :: flip_bit
procedure(flip_range_abstract), deferred, pass(self) :: flip_range
generic :: flip => flip_bit, flip_range
procedure(from_string_abstract), deferred, pass(self) :: from_string
procedure(init_zero_abstract), deferred, pass(self) :: init_zero
generic :: init => init_zero
procedure(input_abstract), deferred, pass(self) :: input
procedure(none_abstract), deferred, pass(self) :: none
procedure(not_abstract), deferred, pass(self) :: not
procedure(output_abstract), deferred, pass(self) :: output
procedure(read_bitset_string_abstract), deferred, pass(self) :: &
read_bitset_string
procedure(read_bitset_unit_abstract), deferred, pass(self) :: &
read_bitset_unit
generic :: read_bitset => read_bitset_string, read_bitset_unit
procedure(set_bit_abstract), deferred, pass(self) :: set_bit
procedure(set_range_abstract), deferred, pass(self) :: set_range
generic :: set => set_bit, set_range
procedure(test_abstract), deferred, pass(self) :: test
procedure(to_string_abstract), deferred, pass(self) :: to_string
procedure(value_abstract), deferred, pass(self) :: value
procedure(write_bitset_string_abstract), deferred, pass(self) :: &
write_bitset_string
procedure(write_bitset_unit_abstract), deferred, pass(self) :: &
write_bitset_unit
generic :: write_bitset => write_bitset_string, write_bitset_unit
end type bitset_type
abstract interface
elemental function all_abstract( self ) result(all)
!! Version: experimental
!!
!! Returns `.true.` if all bits in `self` are 1, `.false.` otherwise.
!!
!!#### Example
!!
!!```fortran
!! program example_all
!! use stdlib_bitsets
!! character(*), parameter :: &
!! bits_all = '111111111111111111111111111111111'
!! type(bitset_64) :: set0
!! call set0 % from_string( bits_all )
!! if ( bits(set0) /= 33 ) then
!! error stop "FROM_STRING failed to interpret " // &
!! 'BITS_ALL's size properly."
!! else if ( .not. set0 % all() ) then
!! error stop "FROM_STRING failed to interpret" // &
!! "BITS_ALL's value properly."
!! else
!! write(*,*) "FROM_STRING transferred BITS_ALL properly" // &
!! " into set0."
!! end if
!! end program example_all
!!```
import :: bitset_type
logical :: all
class(bitset_type), intent(in) :: self
end function all_abstract
elemental function any_abstract(self) result(any)
!! Version: experimental
!!
!! Returns `.true.` if any bit in `self` is 1, `.false.` otherwise.
!!
!!#### Example
!!
!!```fortran
!! program example_any
!! use stdlib_bitsets
!! character(*), parameter :: &
!! bits_0 = '0000000000000000000'
!! type(bitset_64) :: set0
!! call set0 % from_string( bits_0 )
!! if ( .not. set0 % any() ) then
!! write(*,*) "FROM_STRING interpreted " // &
!! "BITS_0's value properly."
!! end if
!! call set0 % set(5)
!! if ( set0 % any() ) then
!! write(*,*) "ANY interpreted SET0's value properly."
!! end if
!! end program example_any
!!```
import :: bitset_type
logical :: any
class(bitset_type), intent(in) :: self
end function any_abstract
elemental function bit_count_abstract(self) result(bit_count)
!! Version: experimental
!!
!! Returns the number of non-zero bits in `self`.
!!
!!#### Example
!!
!!```fortran
!! program example_bit_count
!! use stdlib_bitsets
!! character(*), parameter :: &
!! bits_0 = '0000000000000000000'
!! type(bitset_64) :: set0
!! call set0 % from_string( bits_0 )
!! if ( set0 % bit_count() == 0 ) then
!! write(*,*) "FROM_STRING interpreted " // &
!! "BITS_0's value properly."
!! end if
!! call set0 % set(5)
!! if ( set0 % bit_count() == 1 ) then
!! write(*,*) "BIT_COUNT interpreted SET0's value properly."
!! end if
!! end program example_bit_count
!!```
import :: bitset_type, bits_kind
integer(bits_kind) :: bit_count
class(bitset_type), intent(in) :: self
end function bit_count_abstract
elemental subroutine clear_bit_abstract(self, pos)
!! Version: experimental
!!
!! Sets to zero the `pos` position in `self`. If `pos` is less than zero or
!! greater than `bits(self)-1` it is ignored.
!!
!!#### Example
!!
!!```fortran
!! program example_clear
!! use stdlib_bitsets
!! type(bitset_large) :: set0
!! call set0 % init(166)
!! call set0 % not()
!! if ( set0 % all() ) write(*,*) 'SET0 is properly initialized.'
!! call set0 % clear(165)
!! if ( .not. set0 % test(165) ) write(*,*) 'Bit 165 is cleared.'
!! call set0 % clear(0,164)
!! if ( set0 % none() ) write(*,*) 'All bits are cleared.'
!! end program example_clear
!!```
import :: bitset_type, bits_kind
class(bitset_type), intent(inout) :: self
integer(bits_kind), intent(in) :: pos
end subroutine clear_bit_abstract
pure subroutine clear_range_abstract(self, start_pos, stop_pos)
!! Version: experimental
!!
!! Sets to zero all bits from the `start_pos` to `stop_pos` positions in `set`.
!! If `stop_pos < start_pos` then no bits are modified. Positions outside
!! the range 0 to `bits(self)-1` are ignored.
import :: bitset_type, bits_kind
class(bitset_type), intent(inout) :: self
integer(bits_kind), intent(in) :: start_pos, stop_pos
end subroutine clear_range_abstract
elemental subroutine flip_bit_abstract(self, pos)
!! Version: experimental
!!
!! Flips the value at the `pos` position in `self`, provided the position is
!! valid. If `pos` is less than 0 or greater than `bits(self)-1`, no value is
!! changed.
!!
!!#### Example
!!
!!```fortran
!! program example_flip
!! use stdlib_bitsets
!! type(bitset_large) :: set0
!! call set0 % init(166)
!! if ( set0 % none() ) write(*,*) 'SET0 is properly initialized.'
!! call set0 % flip(165)
!! if ( set0 % test(165) ) write(*,*) 'Bit 165 is flipped.'
!! call set0 % flip(0,164)
!! if ( set0 % all() ) write(*,*) 'All bits are flipped.'
!! end program example_flip
!!```
import :: bitset_type, bits_kind
class(bitset_type), intent(inout) :: self
integer(bits_kind), intent(in) :: pos
end subroutine flip_bit_abstract
pure subroutine flip_range_abstract(self, start_pos, stop_pos)
!! Version: experimental
!!
!! Flips all valid bits from the `start_pos` to the `stop_pos` positions in
!! `self`. If `stop_pos < start_pos` no bits are flipped. Positions less than
!! 0 or greater than `bits(self)-1` are ignored.
import :: bitset_type, bits_kind
class(bitset_type), intent(inout) :: self
integer(bits_kind), intent(in) :: start_pos, stop_pos
end subroutine flip_range_abstract
subroutine from_string_abstract(self, string, status)
!! Version: experimental
!!
!! Initializes the bitset `self` treating `string` as a binary literal
!! `status` may have the values:
!! * `success` - if no problems were found,
!! * `alloc_fault` - if allocation of the bitset failed
!! * `char_string_too_large_error` - if `string` was too large, or
!! * `char_string_invalid_error` - if string had an invalid character.
!!
!!#### Example
!!
!!```fortran
!! program example_from_string
!! use stdlib_bitsets
!! character(*), parameter :: &
!! bits_all = '111111111111111111111111111111111'
!! type(bitset_64) :: set0
!! call set0 % from_string( bits_all )
!! if ( bits(set0) /= 33 ) then
!! error stop "FROM_STRING failed to interpret " // &
!! 'BITS_ALL's size properly."
!! else if ( .not. set0 % all() ) then
!! error stop "FROM_STRING failed to interpret" // &
!! "BITS_ALL's value properly."
!! else
!! write(*,*) "FROM_STRING transferred BITS_ALL properly" // &
!! " into set0."
!! end if
!! end program example_from_string
!!```
import :: bitset_type
class(bitset_type), intent(out) :: self
character(*), intent(in) :: string
integer, intent(out), optional :: status
end subroutine from_string_abstract
subroutine init_zero_abstract(self, bits, status)
!! Creates the bitset, `self`, of size `bits`, with all bits initialized to
!! zero. `bits` must be non-negative. If an error occurs and `status` is
!! absent then processing stops with an informative stop code. `status`
!! will have one of the values;
!! * `success` - if no problems were found,
!! * `alloc_fault` - if memory allocation failed
!! * `array_size_invalid_error` - if `bits` is either negative or larger
!! than 64 with `self` of class `bitset_64`, or
!!
!!#### Example
!!
!!```fortran
!! program example_init
!! use stdlib_bitsets
!! type(bitset_large) :: set0
!! call set0 % init(166)
!! if ( set0 % bits() == 166 ) &
!! write(*,*) `SET0 has the proper size.'
!! if ( set0 % none() ) write(*,*) 'SET0 is properly initialized.'
!! end program example_init
!!```
import :: bitset_type, bits_kind
class(bitset_type), intent(out) :: self
integer(bits_kind), intent(in) :: bits
integer, intent(out), optional :: status
end subroutine init_zero_abstract
subroutine input_abstract(self, unit, status)
!! Version: experimental
!!
!! Reads the components of the bitset, `self`, from the unformatted I/O
!! unit, `unit`, assuming that the components were written using `output`.
!! If an error occurs and `status` is absent then processing stops with
!! an informative stop code. `status` has one of the values:
!! * `success` - if no problem was found
!! * `alloc_fault` - if it failed allocating memory for `self`, or
!! * `array_size_invalid_error` if the `bits(self)` in `unit` is negative
!! or greater than 64 for a `bitset_64` input.
!! * `read_failure` - if it failed during the reads from `unit`
!!
!!#### Example
!!
!!```fortran
!! program example_input
!! character(*), parameter :: &
!! bits_0 = '000000000000000000000000000000000', &
!! bits_1 = '000000000000000000000000000000001', &
!! bits_33 = '100000000000000000000000000000000'
!! integer :: unit
!! type(bitset_64) :: set0, set1, set2, set3, set4, set5
!! call set0 % from_string( bits_0 )
!! call set1 % from_string( bits_1 )
!! call set2 % from_string( bits_33 )
!! open( newunit=unit, file='test.bin', status='replace', &
!! form='unformatted', action='write' )
!! call set2 % output(unit)
!! call set1 % output(unit)
!! call set0 % output(unit)
!! close( unit )
!! open( newunit=unit, file='test.bin', status='old', &
!! form='unformatted', action='read' )
!! call set5 % input(unit)
!! call set4 % input(unit)
!! call set3 % input(unit)
!! close( unit )
!! if ( set3 /= set0 .or. set4 /= set1 .or. set5 /= set2 ) then
!! error stop 'Transfer to and from units using ' // &
!! ' output and input failed.'
!! else
!! write(*,*) 'Transfer to and from units using ' // &
!! 'output and input succeeded.'
!! end if
!! end program example_input
!!```
import :: bitset_type
class(bitset_type), intent(out) :: self
integer, intent(in) :: unit
integer, intent(out), optional :: status
end subroutine input_abstract
elemental function none_abstract(self) result(none)
!! Version: experimental
!!
!! Returns `.true.` if none of the bits in `self` have the value 1.
!!
!!#### Example
!!
!!```fortran
!! program example_none
!! use stdlib_bitsets
!! character(*), parameter :: &
!! bits_0 = '0000000000000000000'
!! type(bitset_large) :: set0
!! call set0 % from_string( bits_0 )
!! if ( set0 % none() ) then
!! write(*,*) "FROM_STRING interpreted " // &
!! "BITS_0's value properly."
!! end if
!! call set0 % set(5)
!! if ( .not. set0 % none() ) then
!! write(*,*) "NONE interpreted SET0's value properly."
!! end if
!! end program example_none
!!```
import :: bitset_type
logical :: none
class(bitset_type), intent(in) :: self
end function none_abstract
elemental subroutine not_abstract(self)
!! Version: experimental
!!
!! Sets the bits in `self` to their logical complement
!!
!!#### Example
!!
!!```fortran
!! program example_not
!! use stdlib_bitsets
!! type(bitset_large) :: set0
!! call set0 % init( 155 )
!! if ( set0 % none() ) then
!! write(*,*) "FROM_STRING interpreted " // &
!! "BITS_0's value properly."
!! end if
!! call set0 % not()
!! if ( set0 % all() ) then
!! write(*,*) "ALL interpreted SET0's value properly."
!! end if
!! end program example_not
!!```
import :: bitset_type
class(bitset_type), intent(inout) :: self
end subroutine not_abstract
subroutine output_abstract(self, unit, status)
!! Version: experimental
!!
!! Writes the components of the bitset, `self`, to the unformatted I/O
!! unit, `unit`, in a unformatted sequence compatible with `input`. If
!! `status` is absent an error results in an error stop with an
!! informative stop code. If `status` is present it has the default
!! value of `success`, or the value `write_failure` if the write failed.
!!
!!#### Example
!!
!!```fortran
!! program example_output
!! character(*), parameter :: &
!! bits_0 = '000000000000000000000000000000000', &
!! bits_1 = '000000000000000000000000000000001', &
!! bits_33 = '100000000000000000000000000000000'
!! integer :: unit
!! type(bitset_64) :: set0, set1, set2, set3, set4, set5
!! call set0 % from_string( bits_0 )
!! call set1 % from_string( bits_1 )
!! call set2 % from_string( bits_33 )
!! open( newunit=unit, file='test.bin', status='replace', &
!! form='unformatted', action='write' )
!! call set2 % output(unit)
!! call set1 % output(unit)
!! call set0 % output(unit)
!! close( unit )
!! open( newunit=unit, file='test.bin', status='old', &
!! form='unformatted', action='read' )
!! call set5 % input(unit)
!! call set4 % input(unit)
!! call set3 % input(unit)
!! close( unit )
!! if ( set3 /= set0 .or. set4 /= set1 .or. set5 /= set2 ) then
!! error stop 'Transfer to and from units using ' // &
!! ' output and input failed.'
!! else
!! write(*,*) 'Transfer to and from units using ' // &
!! 'output and input succeeded.'
!! end if
!! end program example_output
!!```
import :: bitset_type
class(bitset_type), intent(in) :: self
integer, intent(in) :: unit
integer, intent(out), optional :: status
end subroutine output_abstract
subroutine read_bitset_string_abstract(self, string, status)
!! Version: experimental
!!
!! Uses the bitset literal in the default character `string`, to define
!! the bitset, `self`. The literal may be preceded by an an arbitrary
!! sequence of blank characters. If `status` is absent an error results
!! in an error stop with an informative stop code. If `status`
!! is present it has one of the values
!! * `success` - if no problems occurred,
!! * `alloc_fault` - if allocation of memory for SELF failed,
!! * `array_size_invalid_error - if `bits(self)` in `string` is greater
!! than 64 for a `bitset_64`,
!! * `char_string_invalid_error` - if the bitset literal has an invalid
!! character,
!! * `char_string_too_small_error - if the string ends before all the bits
!! are read.
!! * `integer_overflow_error` - if the bitset literal has a `bits(self)`
!! value too large to be represented,
!!
!!#### Example
!!
!!```fortran
!! program example_read_bitset
!! character(*), parameter :: &
!! bits_0 = 'S33B000000000000000000000000000000000', &
!! bits_1 = 'S33B000000000000000000000000000000001', &
!! bits_33 = 'S33B100000000000000000000000000000000'
!! character(:), allocatable :: test_0, test_1, test_2
!! integer :: unit
!! type(bitset_64) :: set0, set1, set2, set3, set4, set5
!! call set0 % read_bitset( bits_0, status )
!! call set1 % read_bitset( bits_1, status )
!! call set2 % read_bitset( bits_2, status )
!! call set0 % write_bitset( test_0, status )
!! call set1 % write_bitset( test_1, status )
!! call set2 % write_bitset( test_2, status )
!! if ( bits_0 == test_0 .and. bits_1 == test_1 .and. &
!! bits_2 == test_2 ) then
!! write(*,*) 'READ_BITSET to WRITE_BITSET strings worked.'
!! end if
!! open( newunit=unit, file='test.txt', status='replace', &
!! form='formatted', action='write' )
!! call set2 % write_bitset(unit, advance='no')
!! call set1 % write_bitset(unit, advance='no')
!! call set0 % write_bitset(unit)
!! close( unit )
!! open( newunit=unit, file='test.txt', status='old', &
!! form='formatted', action='read' )
!! call set3 % read_bitset(unit, advance='no')
!! call set4 % read_bitset(unit, advance='no')
!! call set5 % read_bitset(unit)
!! if ( set3 == set0 .and. set4 == set1 .and. set5 == set2 ) then
!! write(*,*) WRITE_BITSET to READ_BITSET through unit worked.'
!! end if
!! end program example_read_bitset
!!```
import :: bitset_type
class(bitset_type), intent(out) :: self
character(len=*), intent(in) :: string
integer, intent(out), optional :: status
end subroutine read_bitset_string_abstract
subroutine read_bitset_unit_abstract(self, unit, advance, status)
!! Version: experimental
!!
!! Uses the bitset literal at the current position in the formatted
!! file with I/O unit, `unit`, to define the bitset, `self`. The literal
!! may be preceded by an an arbitrary sequence of blank characters.
!! If `advance` is present it must be either 'YES' or 'NO'. If absent
!! it has the default value of 'YES' to determine whether advancing
!! I/O occurs. If `status` is absent an error results in an error stop
!! with an informative stop code. If `status` is present it has one of
!! the values:
!! * `success` - if no problem occurred,
!! * `alloc_fault` - if allocation of `self` failed,
!! * `array_size_invalid_error` - if `bits(self)` in the bitset literal
!! is greater than 64 for a `bitset_64`,
!! * `char_string_invalid_error` - if the read of the bitset literal found
!! an invalid character,
!! * `eof_failure` - if a `read` statement reached an end-of-file before
!! completing the read of the bitset literal,
!! * `integer_overflow_error` - if the bitset literal has a `bits(self)`
!! value too large to be represented,
!! * `read_failure` - if a `read` statement fails,
!
import :: bitset_type
class(bitset_type), intent(out) :: self
integer, intent(in) :: unit
character(*), intent(in), optional :: advance
integer, intent(out), optional :: status
end subroutine read_bitset_unit_abstract
elemental subroutine set_bit_abstract(self, pos)
!! Version: experimental
!!
!! Sets the value at the `pos` position in `self`, provided the position is
!! valid. If the position is less than 0 or greater than `bits(self)-1`
!! then `self` is unchanged.
!!
!!#### Example
!!
!!```fortran
!! program example_set
!! use stdlib_bitsets
!! type(bitset_large) :: set0
!! call set0 % init(166)
!! if ( set0 % none() ) write(*,*) 'SET0 is properly initialized.'
!! call set0 % set(165)
!! if ( set0 % test(165) ) write(*,*) 'Bit 165 is set.'
!! call set0 % set(0,164)
!! if ( set0 % all() ) write(*,*) 'All bits are set.'
!! end program example_set
!!```
import :: bitset_type, bits_kind
class(bitset_type), intent(inout) :: self
integer(bits_kind), intent(in) :: pos
end subroutine set_bit_abstract
pure subroutine set_range_abstract(self, start_pos, stop_pos)
!! Version: experimental
!!
!! Sets all valid bits to 1 from the `start_pos` to the `stop_pos` positions
!! in `self`. If `stop_pos < start_pos` no bits are changed. Positions outside
!! the range 0 to `bits(self)-1` are ignored.
import :: bitset_type, bits_kind
class(bitset_type), intent(inout) :: self
integer(bits_kind), intent(in) :: start_pos, stop_pos
end subroutine set_range_abstract
elemental function test_abstract(self, pos) result(test)
!! Version: experimental
!!
!! Returns `.true.` if the `pos` position is set, `.false.` otherwise. If `pos`
!! is negative or greater than `bits(self) - 1` the result is `.false.`.
!!
!!#### Example
!!
!!```fortran
!! program example_test
!! use stdlib_bitsets
!! type(bitset_large) :: set0
!! call set0 % init(166)
!! call set0 % not()
!! if ( set0 % all() ) write(*,*) 'SET0 is properly initialized.'
!! call set0 % clear(165)
!! if ( .not. set0 % test(165) ) write(*,*) 'Bit 165 is cleared.'
!! call set0 % set(165)
!! if ( set0 % test(165) ) write(*,*) 'Bit 165 is set.'
!! end program example_test
!!```
import :: bitset_type, bits_kind
logical :: test
class(bitset_type), intent(in) :: self
integer(bits_kind), intent(in) :: pos
end function test_abstract
subroutine to_string_abstract(self, string, status)
!! Version: experimental
!!
!! Represents the value of `self` as a binary literal in `string`
!! Status may have the values `success` or `alloc_fault`.
!!
!!#### Example
!!
!!```fortran
!! program example_to_string
!! use stdlib_bitsets
!! character(*), parameter :: &
!! bits_all = '111111111111111111111111111111111'
!! type(bitset_64) :: set0
!! character(:), allocatable :: new_string
!! call set0 % init(33)
!! call set0 % not()
!! call set0 % to_string( new_string )
!! if ( new_string == bits_all ) then
!! write(*,*) "TO_STRING transferred BITS0 properly" // &
!! " into NEW_STRING."
!! end if
!! end program example_to_string
!!```
import :: bitset_type
class(bitset_type), intent(in) :: self
character(:), allocatable, intent(out) :: string
integer, intent(out), optional :: status
end subroutine to_string_abstract
elemental function value_abstract(self, pos) result(value)
!! Version: experimental
!!
!! Returns 1 if the `pos` position is set, 0 otherwise. If `pos` is negative
!! or greater than `bits(set) - 1` the result is 0.
!!
!!#### Example
!!
!!```fortran
!! program example_value
!! use stdlib_bitsets
!! type(bitset_large) :: set0
!! call set0 % init(166)
!! call set0 % not()
!! if ( set0 % all() ) write(*,*) 'SET0 is properly initialized.'
!! call set0 % clear(165)
!! if ( set0 % value(165) == 0 ) write(*,*) 'Bit 165 is cleared.'
!! call set0 % set(165)
!! if ( set0 % value(165) == 1 ) write(*,*) 'Bit 165 is set.'
!! end program example_value
!!```
import :: bitset_type, bits_kind
integer :: value
class(bitset_type), intent(in) :: self
integer(bits_kind), intent(in) :: pos
end function value_abstract
subroutine write_bitset_string_abstract(self, string, status)
!! Version: experimental
!!
!! Writes a bitset literal to the allocatable default character `string`,
!! representing the individual bit values in the `bitset_type`, `self`.
!! If `status` is absent an error results in an error stop with an
!! informative stop code. If `status` is present it has the default
!! value of `success`, or the value `alloc_fault` if allocation of
!! the output string failed.
!!
!!#### Example
!!
!!```fortran
!! program example_write_bitset
!! character(*), parameter :: &
!! bits_0 = 'S33B000000000000000000000000000000000', &
!! bits_1 = 'S33B000000000000000000000000000000001', &
!! bits_33 = 'S33B100000000000000000000000000000000'
!! character(:), allocatable :: test_0, test_1, test_2
!! integer :: unit
!! type(bitset_64) :: set0, set1, set2, set3, set4, set5
!! call set0 % read_bitset( bits_0, status )
!! call set1 % read_bitset( bits_1, status )
!! call set2 % read_bitset( bits_2, status )
!! call set0 % write_bitset( test_0, status )
!! call set1 % write_bitset( test_1, status )
!! call set2 % write_bitset( test_2, status )
!! if ( bits_0 == test_0 .and. bits_1 == test_1 .and. &
!! bits_2 == test_2 ) then
!! write(*,*) 'READ_BITSET to WRITE_BITSET strings worked.'
!! end if
!! open( newunit=unit, file='test.txt', status='replace', &
!! form='formatted', action='write' )
!! call set2 % write_bitset(unit, advance='no')
!! call set1 % write_bitset(unit, advance='no')
!! call set0 % write_bitset(unit)
!! close( unit )
!! open( newunit=unit, file='test.txt', status='old', &
!! form='formatted', action='read' )
!! call set3 % read_bitset(unit, advance='no')
!! call set4 % read_bitset(unit, advance='no')
!! call set5 % read_bitset(unit)
!! if ( set3 == set0 .and. set4 == set1 .and. set5 == set2 ) then
!! write(*,*) WRITE_BITSET to READ_BITSET through unit worked.'
!! end if
!! end program example_write_bitset
!!```
import :: bitset_type
class(bitset_type), intent(in) :: self
character(len=:), allocatable, intent(out) :: string
integer, intent(out), optional :: status
end subroutine write_bitset_string_abstract
subroutine write_bitset_unit_abstract(self, unit, advance, &
status)
!! Version: experimental
!!
!! Writes a bitset literal to the I/O unit, `unit`, representing the
!! individual bit values in the `bitset_t`, `self`. If an error occurs then
!! processing stops with a message to `error_unit`. By default or if
!! `advance` is present with the value 'YES', advancing output is used.
!! If `advance` is present with the value 'NO', then the current record
!! is not advanced by the write. If `status` is absent, an error results
!! in an error stop with an informative stop code. If `status` is
!! present it has the default value of `success`, the value
!! `alloc_fault` if allocation of the output string failed,
!! `write_failure` if the `write` statement outputting the literal failed.
import :: bitset_type
class(bitset_type), intent(in) :: self
integer, intent(in) :: unit
character(len=*), intent(in), optional :: advance
integer, intent(out), optional :: status
end subroutine write_bitset_unit_abstract
end interface
type, extends(bitset_type) :: bitset_large
!! Version: experimental
!!
!! Type for bitsets with more than 64 bits ([Specification](../page/specs/stdlib_bitsets.html#the-stdlib_bitsets-derived-types))
private
integer(block_kind), private, allocatable :: blocks(:)
contains
procedure, pass(self) :: all => all_large
procedure, pass(self) :: any => any_large
procedure, pass(self) :: bit_count => bit_count_large
procedure, pass(self) :: clear_bit => clear_bit_large
procedure, pass(self) :: clear_range => clear_range_large
procedure, pass(self) :: flip_bit => flip_bit_large
procedure, pass(self) :: flip_range => flip_range_large
procedure, pass(self) :: from_string => from_string_large
procedure, pass(self) :: init_zero => init_zero_large
procedure, pass(self) :: input => input_large
procedure, pass(self) :: none => none_large
procedure, pass(self) :: not => not_large
procedure, pass(self) :: output => output_large
procedure, pass(self) :: &
read_bitset_string => read_bitset_string_large
procedure, pass(self) :: read_bitset_unit => read_bitset_unit_large
procedure, pass(self) :: set_bit => set_bit_large
procedure, pass(self) :: set_range => set_range_large
procedure, pass(self) :: test => test_large
procedure, pass(self) :: to_string => to_string_large
procedure, pass(self) :: value => value_large
procedure, pass(self) :: &
write_bitset_string => write_bitset_string_large
procedure, pass(self) :: write_bitset_unit => write_bitset_unit_large
end type bitset_large
interface
elemental module function all_large( self ) result(all)
!! Version: experimental
!!
!! Returns `.true.` if all bits in `self` are 1, `.false.` otherwise.
logical :: all
class(bitset_large), intent(in) :: self
end function all_large
elemental module function any_large(self) result(any)
!! Version: experimental
!!
!! Returns `.true.` if any bit in `self` is 1, `.false.` otherwise.
logical :: any
class(bitset_large), intent(in) :: self
end function any_large
elemental module function bit_count_large(self) result(bit_count)
!! Version: experimental
!!
!! Returns the number of non-zero bits in `self`.
integer(bits_kind) :: bit_count
class(bitset_large), intent(in) :: self
end function bit_count_large
elemental module subroutine clear_bit_large(self, pos)
!! Version: experimental
!!
!! Sets to zero the bit at `pos` position in `self`. If `pos` is less than
!! zero or greater than `bits(self)-1` it is ignored.
class(bitset_large), intent(inout) :: self
integer(bits_kind), intent(in) :: pos
end subroutine clear_bit_large
pure module subroutine clear_range_large(self, start_pos, stop_pos)
!! Version: experimental
!!
!! Sets to zero all bits from the `start_pos` to `stop_pos` positions in `self`.
!! If `stop_pos < start_pos` then no bits are modified. Positions outside
!! the range 0 to `bits(set)-1` are ignored.
class(bitset_large), intent(inout) :: self
integer(bits_kind), intent(in) :: start_pos, stop_pos
end subroutine clear_range_large
elemental module subroutine flip_bit_large(self, pos)
!! Version: experimental
!!
!! Flips the bit value at the `pos` position in `self`, provided the position is
!! valid. If `pos` is less than 0 or greater than `bits(self)-1`, no value is
!! changed.
class(bitset_large), intent(inout) :: self
integer(bits_kind), intent(in) :: pos
end subroutine flip_bit_large
pure module subroutine flip_range_large(self, start_pos, stop_pos)
!! Version: experimental
!!
!! Flips all valid bits from the `start_pos` to the `stop_pos` positions in
!! `self`. If `stop_pos < start_pos` no bits are flipped. Positions less than
!! 0 or greater than `bits(self)-1` are ignored.
class(bitset_large), intent(inout) :: self
integer(bits_kind), intent(in) :: start_pos, stop_pos
end subroutine flip_range_large
module subroutine from_string_large(self, string, status)
!! Version: experimental
!!
!! Initializes the bitset `self` treating `string` as a binary literal
!! `status` may have the values:
!! * `success` - if no problems were found,
!! * `alloc_fault` - if allocation of the bitset failed
!! * `char_string_too_large_error` - if `string` was too large, or
!! * `char_string_invalid_error` - if string had an invalid character.
class(bitset_large), intent(out) :: self
character(*), intent(in) :: string
integer, intent(out), optional :: status
end subroutine from_string_large
module subroutine init_zero_large(self, bits, status)
!! Version: experimental
!!
!! Creates the bitset, `self`, of size `bits`, with all bits initialized to
!! zero. `bits` must be non-negative. If an error occurs and `status` is
!! absent then processing stops with an informative stop code. `status`
!! will have one of the values;
!! * `success` - if no problems were found,
!! * `alloc_fault` - if memory allocation failed
!! * `array_size_invalid_error` - if `bits` is either negative or larger
!! than 64 with `self` of class `bitset_64`, or
class(bitset_large), intent(out) :: self
integer(bits_kind), intent(in) :: bits
integer, intent(out), optional :: status
end subroutine init_zero_large
module subroutine input_large(self, unit, status)
!! Version: experimental
!!
!! Reads the components of the bitset, `self`, from the unformatted I/O
!! unit, `unit`, assuming that the components were written using `output`.
!! If an error occurs and `status` is absent then processing stops with
!! an informative stop code. `status` has one of the values:
!! * `success` - if no problem was found
!! * `alloc_fault` - if it failed allocating memory for `self`, or
!! * `array_size_invalid_error` if the `bits(self)` in `unit` is negative
!! or greater than 64 for a `bitset_64` input.
!! * `read_failure` - if it failed during the reads from `unit`
class(bitset_large), intent(out) :: self
integer, intent(in) :: unit
integer, intent(out), optional :: status
end subroutine input_large
elemental module function none_large(self) result(none)
!! Version: experimental
!!
!! Returns `.true.` if none of the bits in `self` have the value 1.
logical :: none
class(bitset_large), intent(in) :: self
end function none_large
elemental module subroutine not_large(self)
!! Version: experimental
!!
!! Sets the bits in `self` to their logical complement
class(bitset_large), intent(inout) :: self
end subroutine not_large
module subroutine output_large(self, unit, status)
!! Version: experimental
!!
!! Writes the components of the bitset, `self`, to the unformatted I/O
!! unit, `unit`, in a unformatted sequence compatible with `input`. If
!! `status` is absent an error results in an error stop with an
!! informative stop code. If `status` is present it has the default
!! value of `success`, or the value `write_failure` if the write failed.
class(bitset_large), intent(in) :: self
integer, intent(in) :: unit
integer, intent(out), optional :: status
end subroutine output_large
module subroutine read_bitset_string_large(self, string, status)
!! Version: experimental
!!