-
Notifications
You must be signed in to change notification settings - Fork 44
Expand file tree
/
Copy pathColumn.hs
More file actions
1222 lines (1110 loc) · 49.4 KB
/
Column.hs
File metadata and controls
1222 lines (1110 loc) · 49.4 KB
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
{-# LANGUAGE AllowAmbiguousTypes #-}
{-# LANGUAGE ConstraintKinds #-}
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE GADTs #-}
{-# LANGUAGE InstanceSigs #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE PolyKinds #-}
{-# LANGUAGE RankNTypes #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE UndecidableInstances #-}
module DataFrame.Internal.Column where
import qualified Data.Set as S
import qualified Data.Text as T
import qualified Data.Vector as VB
import qualified Data.Vector.Algorithms.Merge as VA
import qualified Data.Vector.Generic as VG
import qualified Data.Vector.Mutable as VBM
import qualified Data.Vector.Unboxed as VU
import qualified Data.Vector.Unboxed.Mutable as VUM
import Control.Exception (throw)
import Control.Monad.ST (runST)
import Data.Kind (Type)
import Data.Maybe
import Data.These
import Data.Type.Equality (TestEquality (..))
import DataFrame.Errors
import DataFrame.Internal.Parsing
import DataFrame.Internal.Types
import Type.Reflection
{- | Our representation of a column is a GADT that can store data based on the underlying data.
This allows us to pattern match on data kinds and limit some operations to only some
kinds of vectors. E.g. operations for missing data only happen in an OptionalColumn.
-}
data Column where
BoxedColumn :: (Columnable a) => VB.Vector a -> Column
UnboxedColumn :: (Columnable a, VU.Unbox a) => VU.Vector a -> Column
OptionalColumn :: (Columnable a) => VB.Vector (Maybe a) -> Column
data MutableColumn where
MBoxedColumn :: (Columnable a) => VBM.IOVector a -> MutableColumn
MUnboxedColumn :: (Columnable a, VU.Unbox a) => VUM.IOVector a -> MutableColumn
{- | A TypedColumn is a wrapper around our type-erased column.
It is used to type check expressions on columns.
-}
data TypedColumn a where
TColumn :: (Columnable a) => Column -> TypedColumn a
instance (Eq a) => Eq (TypedColumn a) where
(==) :: (Eq a) => TypedColumn a -> TypedColumn a -> Bool
(==) (TColumn a) (TColumn b) = a == b
instance (Ord a) => Ord (TypedColumn a) where
compare :: (Ord a) => TypedColumn a -> TypedColumn a -> Ordering
compare (TColumn a) (TColumn b) = compare a b
-- | Gets the underlying value from a TypedColumn.
unwrapTypedColumn :: TypedColumn a -> Column
unwrapTypedColumn (TColumn value) = value
-- | Gets the underlying vector from a TypedColumn.
vectorFromTypedColumn :: TypedColumn a -> VB.Vector a
vectorFromTypedColumn (TColumn value) = either throw id (toVector value)
-- | Checks if a column contains missing values.
hasMissing :: Column -> Bool
hasMissing (OptionalColumn column) = True
hasMissing _ = False
-- | Checks if a column contains only missing values.
allMissing :: Column -> Bool
allMissing (OptionalColumn column) = VB.length (VB.filter isNothing column) == VB.length column
allMissing _ = False
-- | Checks if a column contains numeric values.
isNumeric :: Column -> Bool
isNumeric (UnboxedColumn (vec :: VU.Vector a)) = case sNumeric @a of
STrue -> True
_ -> False
isNumeric (BoxedColumn (vec :: VB.Vector a)) = case testEquality (typeRep @a) (typeRep @Integer) of
Nothing -> False
Just Refl -> True
isNumeric _ = False
-- | Checks if a column is of a given type values.
hasElemType :: forall a. (Columnable a) => Column -> Bool
hasElemType (BoxedColumn (column :: VB.Vector b)) = fromMaybe False $ do
Refl <- testEquality (typeRep @a) (typeRep @b)
pure True
hasElemType (UnboxedColumn (column :: VU.Vector b)) = fromMaybe False $ do
Refl <- testEquality (typeRep @a) (typeRep @b)
pure True
hasElemType (OptionalColumn (column :: VB.Vector b)) = fromMaybe False $ do
Refl <- testEquality (typeRep @a) (typeRep @b)
pure True
-- | An internal/debugging function to get the column type of a column.
columnVersionString :: Column -> String
columnVersionString column = case column of
BoxedColumn _ -> "Boxed"
UnboxedColumn _ -> "Unboxed"
OptionalColumn _ -> "Optional"
{- | An internal/debugging function to get the type stored in the outermost vector
of a column.
-}
columnTypeString :: Column -> String
columnTypeString column = case column of
BoxedColumn (column :: VB.Vector a) -> show (typeRep @a)
UnboxedColumn (column :: VU.Vector a) -> show (typeRep @a)
OptionalColumn (column :: VB.Vector a) -> show (typeRep @a)
instance (Show a) => Show (TypedColumn a) where
show :: (Show a) => TypedColumn a -> String
show (TColumn col) = show col
instance Show Column where
show :: Column -> String
show (BoxedColumn column) = show column
show (UnboxedColumn column) = show column
show (OptionalColumn column) = show column
instance Eq Column where
(==) :: Column -> Column -> Bool
(==) (BoxedColumn (a :: VB.Vector t1)) (BoxedColumn (b :: VB.Vector t2)) =
case testEquality (typeRep @t1) (typeRep @t2) of
Nothing -> False
Just Refl -> a == b
(==) (OptionalColumn (a :: VB.Vector t1)) (OptionalColumn (b :: VB.Vector t2)) =
case testEquality (typeRep @t1) (typeRep @t2) of
Nothing -> False
Just Refl -> a == b
(==) (UnboxedColumn (a :: VU.Vector t1)) (UnboxedColumn (b :: VU.Vector t2)) =
case testEquality (typeRep @t1) (typeRep @t2) of
Nothing -> False
Just Refl -> a == b
(==) _ _ = False
-- Generalised LEQ that does reflection.
generalLEQ ::
forall a b. (Typeable a, Typeable b, Ord a, Ord b) => a -> b -> Bool
generalLEQ x y = case testEquality (typeRep @a) (typeRep @b) of
Nothing -> False
Just Refl -> x <= y
instance Ord Column where
(<=) :: Column -> Column -> Bool
(<=) (BoxedColumn (a :: VB.Vector t1)) (BoxedColumn (b :: VB.Vector t2)) = generalLEQ a b
(<=) (OptionalColumn (a :: VB.Vector t1)) (OptionalColumn (b :: VB.Vector t2)) = generalLEQ a b
(<=) (UnboxedColumn (a :: VU.Vector t1)) (UnboxedColumn (b :: VU.Vector t2)) = generalLEQ a b
(<=) _ _ = False
{- | A class for converting a vector to a column of the appropriate type.
Given each Rep we tell the `toColumnRep` function which Column type to pick.
-}
class ColumnifyRep (r :: Rep) a where
toColumnRep :: VB.Vector a -> Column
-- | Constraint synonym for what we can put into columns.
type Columnable a =
( Columnable' a
, ColumnifyRep (KindOf a) a
, UnboxIf a
, IntegralIf a
, FloatingIf a
, SBoolI (Unboxable a)
, SBoolI (Numeric a)
, SBoolI (IntegralTypes a)
, SBoolI (FloatingTypes a)
)
instance
(Columnable a, VU.Unbox a) =>
ColumnifyRep 'RUnboxed a
where
toColumnRep :: (Columnable a, VUM.Unbox a) => VB.Vector a -> Column
toColumnRep = UnboxedColumn . VU.convert
instance
(Columnable a) =>
ColumnifyRep 'RBoxed a
where
toColumnRep :: (Columnable a) => VB.Vector a -> Column
toColumnRep = BoxedColumn
instance
(Columnable a) =>
ColumnifyRep 'ROptional (Maybe a)
where
toColumnRep = OptionalColumn
{- | O(n) Convert a vector to a column. Automatically picks the best representation of a vector to store the underlying data in.
__Examples:__
@
> import qualified Data.Vector as V
> fromVector (VB.fromList [(1 :: Int), 2, 3, 4])
[1,2,3,4]
@
-}
fromVector ::
forall a.
(Columnable a, ColumnifyRep (KindOf a) a) =>
VB.Vector a -> Column
fromVector = toColumnRep @(KindOf a)
{- | O(n) Convert an unboxed vector to a column. This avoids the extra conversion if you already have the data in an unboxed vector.
__Examples:__
@
> import qualified Data.Vector.Unboxed as V
> fromUnboxedVector (VB.fromList [(1 :: Int), 2, 3, 4])
[1,2,3,4]
@
-}
fromUnboxedVector ::
forall a. (Columnable a, VU.Unbox a) => VU.Vector a -> Column
fromUnboxedVector = UnboxedColumn
{- | O(n) Convert a list to a column. Automatically picks the best representation of a vector to store the underlying data in.
__Examples:__
@
> fromList [(1 :: Int), 2, 3, 4]
[1,2,3,4]
@
-}
fromList ::
forall a.
(Columnable a, ColumnifyRep (KindOf a) a) =>
[a] -> Column
fromList = toColumnRep @(KindOf a) . VB.fromList
throwTypeMismatch ::
forall (a :: Type) (b :: Type).
(Typeable a, Typeable b) => Either DataFrameException Column
throwTypeMismatch =
Left $
TypeMismatchException
MkTypeErrorContext
{ userType = Right (typeRep @b)
, expectedType = Right (typeRep @a)
, callingFunctionName = Just "mapColumn"
, errorColumnName = Nothing
}
-- | An internal function to map a function over the values of a column.
mapColumn ::
forall b c.
(Columnable b, Columnable c) =>
(b -> c) -> Column -> Either DataFrameException Column
mapColumn f = \case
BoxedColumn (col :: VB.Vector a) -> run col
OptionalColumn (col :: VB.Vector a) -> run col
UnboxedColumn (col :: VU.Vector a) -> runUnboxed col
where
run :: forall a. (Typeable a) => VB.Vector a -> Either DataFrameException Column
run col = case testEquality (typeRep @a) (typeRep @b) of
Just Refl -> Right (fromVector @c (VB.map f col))
Nothing -> throwTypeMismatch @a @b
runUnboxed ::
forall a.
(Typeable a, VU.Unbox a) => VU.Vector a -> Either DataFrameException Column
runUnboxed col = case testEquality (typeRep @a) (typeRep @b) of
Just Refl -> Right $ case sUnbox @c of
STrue -> UnboxedColumn (VU.map f col)
SFalse -> fromVector @c (VB.generate (VU.length col) (f . VU.unsafeIndex col))
Nothing -> throwTypeMismatch @a @b
{-# SPECIALIZE mapColumn ::
(Double -> Double) -> Column -> Either DataFrameException Column
#-}
{-# INLINEABLE mapColumn #-}
-- | Applies a function that returns an unboxed result to an unboxed vector, storing the result in a column.
imapColumn ::
forall b c.
(Columnable b, Columnable c) =>
(Int -> b -> c) -> Column -> Either DataFrameException Column
imapColumn f = \case
BoxedColumn (col :: VB.Vector a) -> run col
OptionalColumn (col :: VB.Vector a) -> run col
UnboxedColumn (col :: VU.Vector a) -> runUnboxed col
where
run :: forall a. (Typeable a) => VB.Vector a -> Either DataFrameException Column
run col = case testEquality (typeRep @a) (typeRep @b) of
Just Refl -> Right (fromVector @c (VB.imap f col))
Nothing -> throwTypeMismatch @a @b
runUnboxed ::
forall a.
(Typeable a, VU.Unbox a) => VU.Vector a -> Either DataFrameException Column
runUnboxed col = case testEquality (typeRep @a) (typeRep @b) of
Just Refl -> Right $ case sUnbox @c of
STrue -> UnboxedColumn (VU.imap f col)
SFalse -> BoxedColumn (VB.imap f (VG.convert col))
Nothing -> throwTypeMismatch @a @b
-- | O(1) Gets the number of elements in the column.
columnLength :: Column -> Int
columnLength (BoxedColumn xs) = VG.length xs
columnLength (UnboxedColumn xs) = VG.length xs
columnLength (OptionalColumn xs) = VG.length xs
{-# INLINE columnLength #-}
-- | O(n) Gets the number of elements in the column.
numElements :: Column -> Int
numElements (BoxedColumn xs) = VG.length xs
numElements (UnboxedColumn xs) = VG.length xs
numElements (OptionalColumn xs) = VG.foldl' (\acc x -> acc + fromEnum (isJust x)) 0 xs
{-# INLINE numElements #-}
-- | O(n) Takes the first n values of a column.
takeColumn :: Int -> Column -> Column
takeColumn n (BoxedColumn xs) = BoxedColumn $ VG.take n xs
takeColumn n (UnboxedColumn xs) = UnboxedColumn $ VG.take n xs
takeColumn n (OptionalColumn xs) = OptionalColumn $ VG.take n xs
{-# INLINE takeColumn #-}
-- | O(n) Takes the last n values of a column.
takeLastColumn :: Int -> Column -> Column
takeLastColumn n column = sliceColumn (columnLength column - n) n column
{-# INLINE takeLastColumn #-}
-- | O(n) Takes n values after a given column index.
sliceColumn :: Int -> Int -> Column -> Column
sliceColumn start n (BoxedColumn xs) = BoxedColumn $ VG.slice start n xs
sliceColumn start n (UnboxedColumn xs) = UnboxedColumn $ VG.slice start n xs
sliceColumn start n (OptionalColumn xs) = OptionalColumn $ VG.slice start n xs
{-# INLINE sliceColumn #-}
-- | O(n) Selects the elements at a given set of indices. May change the order.
atIndices :: S.Set Int -> Column -> Column
atIndices indexes (BoxedColumn column) = BoxedColumn $ VG.ifilter (\i _ -> i `S.member` indexes) column
atIndices indexes (OptionalColumn column) = OptionalColumn $ VG.ifilter (\i _ -> i `S.member` indexes) column
atIndices indexes (UnboxedColumn column) = UnboxedColumn $ VU.ifilter (\i _ -> i `S.member` indexes) column
{-# INLINE atIndices #-}
-- | O(n) Selects the elements at a given set of indices. Does not change the order.
atIndicesStable :: VU.Vector Int -> Column -> Column
atIndicesStable indexes (BoxedColumn column) = BoxedColumn $ VG.unsafeBackpermute column (VG.convert indexes)
atIndicesStable indexes (UnboxedColumn column) = UnboxedColumn $ VU.unsafeBackpermute column indexes
atIndicesStable indexes (OptionalColumn column) = OptionalColumn $ VG.unsafeBackpermute column (VG.convert indexes)
{-# INLINE atIndicesStable #-}
atIndicesWithNulls :: VB.Vector (Maybe Int) -> Column -> Column
atIndicesWithNulls indices column =
case column of
BoxedColumn col ->
OptionalColumn $ VB.map (fmap (col VB.!)) indices
UnboxedColumn col ->
OptionalColumn $ VB.map (fmap (col VU.!)) indices
OptionalColumn col ->
OptionalColumn $ VB.map (\ix -> ix >>= (col VB.!)) indices
-- | Internal helper to get indices in a boxed vector.
getIndices :: VU.Vector Int -> VB.Vector a -> VB.Vector a
getIndices indices xs = VB.generate (VU.length indices) (\i -> xs VB.! (indices VU.! i))
{-# INLINE getIndices #-}
-- | Internal helper to get indices in an unboxed vector.
getIndicesUnboxed :: (VU.Unbox a) => VU.Vector Int -> VU.Vector a -> VU.Vector a
getIndicesUnboxed indices xs = VU.generate (VU.length indices) (\i -> xs VU.! (indices VU.! i))
{-# INLINE getIndicesUnboxed #-}
findIndices ::
forall a.
(Columnable a) =>
(a -> Bool) ->
Column ->
Either DataFrameException (VU.Vector Int)
findIndices pred = \case
BoxedColumn (v :: VB.Vector b) -> run v VG.convert
OptionalColumn (v :: VB.Vector b) -> run v VG.convert
UnboxedColumn (v :: VU.Vector b) -> run v id
where
run ::
forall b v.
(Typeable b, VG.Vector v b, VG.Vector v Int) =>
v b ->
(v Int -> VU.Vector Int) ->
Either DataFrameException (VU.Vector Int)
run column finalize = case testEquality (typeRep @a) (typeRep @b) of
Just Refl -> Right . finalize $ VG.findIndices pred column
Nothing ->
Left $
TypeMismatchException
MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @b)
, callingFunctionName = Just "findIndices"
, errorColumnName = Nothing
}
-- | An internal function that returns a vector of how indexes change after a column is sorted.
sortedIndexes :: Bool -> Column -> VU.Vector Int
sortedIndexes asc = \case
BoxedColumn column -> sortWorker column
UnboxedColumn column -> sortWorker column
OptionalColumn column -> sortWorker column
where
sortWorker ::
(VG.Vector v a, Ord a, VG.Vector v (Int, a), VG.Vector v Int) =>
v a -> VU.Vector Int
sortWorker column = runST $ do
withIndexes <- VG.thaw $ VG.indexed column
let cmp = if asc then compare else flip compare
VA.sortBy (\(_, b) (_, b') -> cmp b b') withIndexes
sorted <- VG.unsafeFreeze withIndexes
return $ VG.convert $ VG.map fst sorted
{-# INLINE sortedIndexes #-}
-- | Fold (right) column with index.
ifoldrColumn ::
forall a b.
(Columnable a, Columnable b) =>
(Int -> a -> b -> b) -> b -> Column -> Either DataFrameException b
ifoldrColumn f acc c@(BoxedColumn (column :: VB.Vector d)) = case testEquality (typeRep @a) (typeRep @d) of
Just Refl -> pure $ VG.ifoldr f acc column
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @d)
, callingFunctionName = Just "ifoldrColumn"
, errorColumnName = Nothing
}
)
ifoldrColumn f acc c@(OptionalColumn (column :: VB.Vector d)) = case testEquality (typeRep @a) (typeRep @d) of
Just Refl -> pure $ VG.ifoldr f acc column
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @d)
, callingFunctionName = Just "ifoldrColumn"
, errorColumnName = Nothing
}
)
ifoldrColumn f acc c@(UnboxedColumn (column :: VU.Vector d)) = case testEquality (typeRep @a) (typeRep @d) of
Just Refl -> pure $ VG.ifoldr f acc column
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @d)
, callingFunctionName = Just "ifoldrColumn"
, errorColumnName = Nothing
}
)
foldlColumn ::
forall a b.
(Columnable a, Columnable b) =>
(b -> a -> b) -> b -> Column -> Either DataFrameException b
foldlColumn f acc c@(BoxedColumn (column :: VB.Vector d)) = case testEquality (typeRep @a) (typeRep @d) of
Just Refl -> pure $ VG.foldl' f acc column
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @d)
, callingFunctionName = Just "foldlColumn"
, errorColumnName = Nothing
}
)
foldlColumn f acc c@(OptionalColumn (column :: VB.Vector d)) = case testEquality (typeRep @a) (typeRep @d) of
Just Refl -> pure $ VG.foldl' f acc column
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @d)
, callingFunctionName = Just "foldlColumn"
, errorColumnName = Nothing
}
)
foldlColumn f acc c@(UnboxedColumn (column :: VU.Vector d)) = case testEquality (typeRep @a) (typeRep @d) of
Just Refl -> pure $ VG.foldl' f acc column
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @d)
, callingFunctionName = Just "foldlColumn"
, errorColumnName = Nothing
}
)
foldl1Column ::
forall a.
(Columnable a) =>
(a -> a -> a) -> Column -> Either DataFrameException a
foldl1Column f c@(BoxedColumn (column :: VB.Vector d)) = case testEquality (typeRep @a) (typeRep @d) of
Just Refl -> pure $ VG.foldl1' f column
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @d)
, callingFunctionName = Just "foldl1Column"
, errorColumnName = Nothing
}
)
foldl1Column f c@(OptionalColumn (column :: VB.Vector d)) = case testEquality (typeRep @a) (typeRep @d) of
Just Refl -> pure $ VG.foldl1' f column
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @d)
, callingFunctionName = Just "foldl1Column"
, errorColumnName = Nothing
}
)
foldl1Column f c@(UnboxedColumn (column :: VU.Vector d)) = case testEquality (typeRep @a) (typeRep @d) of
Just Refl -> pure $ VG.foldl1' f column
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @d)
, callingFunctionName = Just "foldl1Column"
, errorColumnName = Nothing
}
)
headColumn :: forall a. (Columnable a) => Column -> Either DataFrameException a
headColumn (BoxedColumn (col :: VB.Vector b)) = case testEquality (typeRep @a) (typeRep @b) of
Just Refl ->
if VG.null col
then Left (EmptyDataSetException "headColumn")
else pure (VG.head col)
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @b)
, callingFunctionName = Just "headColumn"
, errorColumnName = Nothing
}
)
headColumn (UnboxedColumn (col :: VU.Vector b)) = case testEquality (typeRep @a) (typeRep @b) of
Just Refl ->
if VG.null col
then Left (EmptyDataSetException "headColumn")
else pure (VG.head col)
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @b)
, callingFunctionName = Just "headColumn"
, errorColumnName = Nothing
}
)
headColumn (OptionalColumn (col :: VB.Vector b)) = case testEquality (typeRep @a) (typeRep @b) of
Just Refl ->
if VG.null col
then Left (EmptyDataSetException "headColumn")
else pure (VG.head col)
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @b)
, callingFunctionName = Just "headColumn"
, errorColumnName = Nothing
}
)
-- | An internal, column version of zip.
zipColumns :: Column -> Column -> Column
zipColumns (BoxedColumn column) (BoxedColumn other) = BoxedColumn (VG.zip column other)
zipColumns (BoxedColumn column) (UnboxedColumn other) =
BoxedColumn
( VB.generate
(min (VG.length column) (VG.length other))
(\i -> (column VG.! i, other VG.! i))
)
zipColumns (BoxedColumn column) (OptionalColumn optcolumn) = BoxedColumn (VG.zip (VB.convert column) optcolumn)
zipColumns (UnboxedColumn column) (BoxedColumn other) =
BoxedColumn
( VB.generate
(min (VG.length column) (VG.length other))
(\i -> (column VG.! i, other VG.! i))
)
zipColumns (UnboxedColumn column) (UnboxedColumn other) = UnboxedColumn (VG.zip column other)
zipColumns (UnboxedColumn column) (OptionalColumn optcolumn) = BoxedColumn (VG.zip (VB.convert column) optcolumn)
zipColumns (OptionalColumn optcolumn) (BoxedColumn column) = BoxedColumn (VG.zip optcolumn (VB.convert column))
zipColumns (OptionalColumn optcolumn) (UnboxedColumn column) = BoxedColumn (VG.zip optcolumn (VB.convert column))
zipColumns (OptionalColumn optcolumn) (OptionalColumn optother) = BoxedColumn (VG.zip optcolumn optother)
{-# INLINE zipColumns #-}
-- | Merge two columns using `These`.
mergeColumns :: Column -> Column -> Column
mergeColumns colA colB = case (colA, colB) of
(OptionalColumn c1, OptionalColumn c2) ->
OptionalColumn $ mkVec c1 c2 $ \v1 v2 ->
case (v1, v2) of
(Nothing, Nothing) -> Nothing
(Just x, Nothing) -> Just (This x)
(Nothing, Just y) -> Just (That y)
(Just x, Just y) -> Just (These x y)
(OptionalColumn c1, BoxedColumn c2) -> optReq c1 c2
(OptionalColumn c1, UnboxedColumn c2) -> optReq c1 c2
(BoxedColumn c1, OptionalColumn c2) -> reqOpt c1 c2
(UnboxedColumn c1, OptionalColumn c2) -> reqOpt c1 c2
(BoxedColumn c1, BoxedColumn c2) -> reqReq c1 c2
(BoxedColumn c1, UnboxedColumn c2) -> reqReq c1 c2
(UnboxedColumn c1, BoxedColumn c2) -> reqReq c1 c2
(UnboxedColumn c1, UnboxedColumn c2) -> reqReq c1 c2
where
mkVec c1 c2 combineElements =
VB.generate
(min (VG.length c1) (VG.length c2))
(\i -> combineElements (c1 VG.! i) (c2 VG.! i))
{-# INLINE mkVec #-}
reqReq c1 c2 = BoxedColumn $ mkVec c1 c2 These
reqOpt c1 c2 = BoxedColumn $ mkVec c1 c2 $ \v1 v2 ->
case v2 of
Nothing -> This v1
Just y -> These v1 y
optReq c1 c2 = BoxedColumn $ mkVec c1 c2 $ \v1 v2 ->
case v1 of
Nothing -> That v2
Just x -> These x v2
{-# INLINE mergeColumns #-}
-- | An internal, column version of zipWith.
zipWithColumns ::
forall a b c.
(Columnable a, Columnable b, Columnable c) =>
(a -> b -> c) -> Column -> Column -> Either DataFrameException Column
zipWithColumns f (UnboxedColumn (column :: VU.Vector d)) (UnboxedColumn (other :: VU.Vector e)) = case testEquality (typeRep @a) (typeRep @d) of
Just Refl -> case testEquality (typeRep @b) (typeRep @e) of
Just Refl -> pure $ case sUnbox @c of
STrue -> fromUnboxedVector (VU.zipWith f column other)
SFalse -> fromVector $ VB.zipWith f (VG.convert column) (VG.convert other)
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @b)
, expectedType = Right (typeRep @e)
, callingFunctionName = Just "zipWithColumns"
, errorColumnName = Nothing
}
)
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @d)
, callingFunctionName = Just "zipWithColumns"
, errorColumnName = Nothing
}
)
zipWithColumns f left right = case toVector @a left of
Left (TypeMismatchException context) ->
Left $
TypeMismatchException (context{callingFunctionName = Just "zipWithColumns"})
Left e -> Left e
Right left' -> case toVector @b right of
Left (TypeMismatchException context) ->
Left $
TypeMismatchException (context{callingFunctionName = Just "zipWithColumns"})
Left e -> Left e
Right right' -> pure $ fromVector $ VB.zipWith f left' right'
{-# INLINE zipWithColumns #-}
-- Functions for mutable columns (intended for IO).
writeColumn :: Int -> T.Text -> MutableColumn -> IO (Either T.Text Bool)
writeColumn i value (MBoxedColumn (col :: VBM.IOVector a)) =
let
in case testEquality (typeRep @a) (typeRep @T.Text) of
Just Refl ->
( if isNullish value
then VBM.unsafeWrite col i "" >> return (Left $! value)
else VBM.unsafeWrite col i value >> return (Right True)
)
Nothing -> return (Left value)
writeColumn i value (MUnboxedColumn (col :: VUM.IOVector a)) =
case testEquality (typeRep @a) (typeRep @Int) of
Just Refl -> case readInt value of
Just v -> VUM.unsafeWrite col i v >> return (Right True)
Nothing -> VUM.unsafeWrite col i 0 >> return (Left value)
Nothing -> case testEquality (typeRep @a) (typeRep @Double) of
Nothing -> return (Left $! value)
Just Refl -> case readDouble value of
Just v -> VUM.unsafeWrite col i v >> return (Right True)
Nothing -> VUM.unsafeWrite col i 0 >> return (Left $! value)
{-# INLINE writeColumn #-}
freezeColumn' :: [(Int, T.Text)] -> MutableColumn -> IO Column
freezeColumn' nulls (MBoxedColumn col)
| null nulls = BoxedColumn <$> VB.unsafeFreeze col
| all (isNullish . snd) nulls =
OptionalColumn
. VB.imap (\i v -> if i `elem` map fst nulls then Nothing else Just v)
<$> VB.unsafeFreeze col
| otherwise =
BoxedColumn
. VB.imap
( \i v ->
if i `elem` map fst nulls
then Left (fromMaybe (error "UNEXPECTED ERROR DURING FREEZE") (lookup i nulls))
else Right v
)
<$> VB.unsafeFreeze col
freezeColumn' nulls (MUnboxedColumn col)
| null nulls = UnboxedColumn <$> VU.unsafeFreeze col
| all (isNullish . snd) nulls =
VU.unsafeFreeze col >>= \c ->
return $
OptionalColumn $
VB.generate
(VU.length c)
(\i -> if i `elem` map fst nulls then Nothing else Just (c VU.! i))
| otherwise =
VU.unsafeFreeze col >>= \c ->
return $
BoxedColumn $
VB.generate
(VU.length c)
( \i ->
if i `elem` map fst nulls
then Left (fromMaybe (error "UNEXPECTED ERROR DURING FREEZE") (lookup i nulls))
else Right (c VU.! i)
)
{-# INLINE freezeColumn' #-}
-- | Fills the end of a column, up to n, with Nothing. Does nothing if column has length greater than n.
expandColumn :: Int -> Column -> Column
expandColumn n (OptionalColumn col) = OptionalColumn $ col <> VB.replicate (n - VG.length col) Nothing
expandColumn n column@(BoxedColumn col)
| n > VG.length col =
OptionalColumn $ VB.map Just col <> VB.replicate (n - VG.length col) Nothing
| otherwise = column
expandColumn n column@(UnboxedColumn col)
| n > VG.length col =
OptionalColumn $
VB.map Just (VU.convert col) <> VB.replicate (n - VG.length col) Nothing
| otherwise = column
-- | Fills the beginning of a column, up to n, with Nothing. Does nothing if column has length greater than n.
leftExpandColumn :: Int -> Column -> Column
leftExpandColumn n column@(OptionalColumn col)
| n > VG.length col =
OptionalColumn $ VG.replicate (n - VG.length col) Nothing <> col
| otherwise = column
leftExpandColumn n column@(BoxedColumn col)
| n > VG.length col =
OptionalColumn $ VG.replicate (n - VG.length col) Nothing <> VG.map Just col
| otherwise = column
leftExpandColumn n column@(UnboxedColumn col)
| n > VG.length col =
OptionalColumn $
VG.replicate (n - VG.length col) Nothing <> VG.map Just (VU.convert col)
| otherwise = column
{- | Concatenates two columns.
Returns Nothing if the columns are of different types.
-}
concatColumns :: Column -> Column -> Either DataFrameException Column
concatColumns (OptionalColumn left) (OptionalColumn right) = case testEquality (typeOf left) (typeOf right) of
Just Refl -> pure (OptionalColumn $ left <> right)
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeOf right)
, expectedType = Right (typeOf left)
, callingFunctionName = Just "concatColumns"
, errorColumnName = Nothing
}
)
concatColumns (BoxedColumn left) (BoxedColumn right) = case testEquality (typeOf left) (typeOf right) of
Just Refl -> pure (BoxedColumn $ left <> right)
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeOf right)
, expectedType = Right (typeOf left)
, callingFunctionName = Just "concatColumns"
, errorColumnName = Nothing
}
)
concatColumns (UnboxedColumn left) (UnboxedColumn right) = case testEquality (typeOf left) (typeOf right) of
Just Refl -> pure (UnboxedColumn $ left <> right)
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeOf right)
, expectedType = Right (typeOf left)
, callingFunctionName = Just "concatColumns"
, errorColumnName = Nothing
}
)
concatColumns left right =
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeOf right)
, expectedType = Right (typeOf left)
, callingFunctionName = Just "concatColumns"
, errorColumnName = Nothing
}
)
{- | Concatenates two columns.
Works similar to 'concatColumns', but unlike that function, it will also combine columns of different types
by wrapping the values in an Either.
E.g. combining Column containing [1,2] with Column containing ["a","b"]
will result in a Column containing [Left 1, Left 2, Right "a", Right "b"].
-}
concatColumnsEither :: Column -> Column -> Column
concatColumnsEither (OptionalColumn left) (OptionalColumn right) = case testEquality (typeOf left) (typeOf right) of
Nothing ->
OptionalColumn $ fmap (fmap Left) left <> fmap (fmap Right) right
Just Refl ->
OptionalColumn $ left <> right
concatColumnsEither (BoxedColumn left) (BoxedColumn right) = case testEquality (typeOf left) (typeOf right) of
Nothing ->
BoxedColumn $ fmap Left left <> fmap Right right
Just Refl ->
BoxedColumn $ left <> right
concatColumnsEither (UnboxedColumn left) (UnboxedColumn right) = case testEquality (typeOf left) (typeOf right) of
Nothing ->
BoxedColumn $ fmap Left (VG.convert left) <> fmap Right (VG.convert right)
Just Refl ->
UnboxedColumn $ left <> right
concatColumnsEither (BoxedColumn left) (UnboxedColumn right) =
BoxedColumn $ fmap Left left <> fmap Right (VG.convert right)
concatColumnsEither (UnboxedColumn left) (BoxedColumn right) =
BoxedColumn $ fmap Left (VG.convert left) <> fmap Right right
concatColumnsEither (OptionalColumn (left :: VB.Vector (Maybe a))) (BoxedColumn (right :: VB.Vector b)) =
case testEquality (typeRep @a) (typeRep @b) of
Just Refl -> OptionalColumn $ left <> fmap Just right
Nothing -> OptionalColumn $ fmap (fmap Left) left <> fmap (Just . Right) right
concatColumnsEither (BoxedColumn (left :: VB.Vector a)) (OptionalColumn (right :: VB.Vector (Maybe b))) =
case testEquality (typeRep @a) (typeRep @b) of
Just Refl -> OptionalColumn $ fmap Just left <> right
Nothing -> OptionalColumn $ fmap (Just . Left) left <> fmap (fmap Right) right
concatColumnsEither (OptionalColumn (left :: VB.Vector (Maybe a))) (UnboxedColumn (right :: VU.Vector b)) =
case testEquality (typeRep @a) (typeRep @b) of
Just Refl -> OptionalColumn $ left <> fmap Just (VG.convert right)
Nothing ->
OptionalColumn $ fmap (fmap Left) left <> fmap (Just . Right) (VG.convert right)
concatColumnsEither (UnboxedColumn (left :: VU.Vector a)) (OptionalColumn (right :: VB.Vector (Maybe b))) =
case testEquality (typeRep @a) (typeRep @b) of
Just Refl -> OptionalColumn $ fmap Just (VG.convert left) <> right
Nothing ->
OptionalColumn $ fmap (Just . Left) (VG.convert left) <> fmap (fmap Right) right
{- | O(n) Converts a column to a list. Throws an exception if the wrong type is specified.
__Examples:__
@
> column = fromList [(1 :: Int), 2, 3, 4]
> toList @Int column
[1,2,3,4]
> toList @Double column
exception: ...
@
-}
toList :: forall a. (Columnable a) => Column -> [a]
toList xs = case toVector @a xs of
Left err -> throw err
Right val -> VB.toList val
{- | Converts a column to a vector of a specific type.
This is a type-safe conversion that requires the column's element type
to exactly match the requested type. You must specify the desired type
via type applications.
==== __Type Parameters__
[@a@] The element type to convert to
[@v@] The vector type (e.g., 'VU.Vector', 'VB.Vector')
==== __Examples__
>>> toVector @Int @VU.Vector column
Right (unboxed vector of Ints)
>>> toVector @Text @VB.Vector column
Right (boxed vector of Text)
==== __Returns__
* 'Right' - The converted vector if types match
* 'Left' 'TypeMismatchException' - If the column's type doesn't match the requested type
==== __See also__
For numeric conversions with automatic type coercion, see 'toDoubleVector',
'toFloatVector', and 'toIntVector'.
-}
toVector ::
forall a v.
(VG.Vector v a, Columnable a) => Column -> Either DataFrameException (v a)
toVector column@(OptionalColumn (col :: VB.Vector b)) =
case testEquality (typeRep @a) (typeRep @b) of
Just Refl -> Right $ VG.convert col
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @b)
, callingFunctionName = Just "toVector"
, errorColumnName = Nothing
}
)
toVector (BoxedColumn (col :: VB.Vector b)) =
case testEquality (typeRep @a) (typeRep @b) of
Just Refl -> Right $ VG.convert col
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @b)
, callingFunctionName = Just "toVector"
, errorColumnName = Nothing
}
)
toVector (UnboxedColumn (col :: VU.Vector b)) =
case testEquality (typeRep @a) (typeRep @b) of
Just Refl -> Right $ VG.convert col
Nothing ->
Left $
TypeMismatchException
( MkTypeErrorContext
{ userType = Right (typeRep @a)
, expectedType = Right (typeRep @b)
, callingFunctionName = Just "toVector"
, errorColumnName = Nothing
}
)
-- Some common types we will use for numerical computing.
{- | Converts a column to an unboxed vector of 'Double' values.
This function performs intelligent type coercion for numeric types:
* If the column is already 'Double', returns it directly
* If the column contains other floating-point types, converts via 'realToFrac'
* If the column contains integral types, converts via 'fromIntegral' (beware of overflow if the type is `Integer`).
==== __Optional column handling__
For 'OptionalColumn' types, 'Nothing' values are converted to @NaN@ (Not a Number).
This allows optional numeric data to be represented in the resulting vector.
==== __Returns__
* 'Right' - The converted 'Double' vector
* 'Left' 'TypeMismatchException' - If the column is not numeric
-}
toDoubleVector :: Column -> Either DataFrameException (VU.Vector Double)
toDoubleVector column =