polars_core/chunked_array/ops/
full.rs

1use arrow::bitmap::Bitmap;
2
3use crate::chunked_array::builder::get_list_builder;
4use crate::prelude::*;
5use crate::series::IsSorted;
6
7impl<T> ChunkFull<T::Native> for ChunkedArray<T>
8where
9    T: PolarsNumericType,
10{
11    fn full(name: PlSmallStr, value: T::Native, length: usize) -> Self {
12        let data = vec![value; length];
13        let mut out = ChunkedArray::from_vec(name, data);
14        out.set_sorted_flag(IsSorted::Ascending);
15        out
16    }
17}
18
19impl<T> ChunkFullNull for ChunkedArray<T>
20where
21    T: PolarsNumericType,
22{
23    fn full_null(name: PlSmallStr, length: usize) -> Self {
24        let arr = PrimitiveArray::new_null(
25            T::get_static_dtype().to_arrow(CompatLevel::newest()),
26            length,
27        );
28        ChunkedArray::with_chunk(name, arr)
29    }
30}
31impl ChunkFull<bool> for BooleanChunked {
32    fn full(name: PlSmallStr, value: bool, length: usize) -> Self {
33        let bits = Bitmap::new_with_value(value, length);
34        let arr = BooleanArray::from_data_default(bits, None);
35        let mut out = BooleanChunked::with_chunk(name, arr);
36        out.set_sorted_flag(IsSorted::Ascending);
37        out
38    }
39}
40
41impl ChunkFullNull for BooleanChunked {
42    fn full_null(name: PlSmallStr, length: usize) -> Self {
43        let arr = BooleanArray::new_null(ArrowDataType::Boolean, length);
44        ChunkedArray::with_chunk(name, arr)
45    }
46}
47
48impl<'a> ChunkFull<&'a str> for StringChunked {
49    fn full(name: PlSmallStr, value: &'a str, length: usize) -> Self {
50        let mut builder = StringChunkedBuilder::new(name, length);
51        builder.chunk_builder.extend_constant(length, Some(value));
52        let mut out = builder.finish();
53        out.set_sorted_flag(IsSorted::Ascending);
54        out
55    }
56}
57
58impl ChunkFullNull for StringChunked {
59    fn full_null(name: PlSmallStr, length: usize) -> Self {
60        let arr = Utf8ViewArray::new_null(DataType::String.to_arrow(CompatLevel::newest()), length);
61        ChunkedArray::with_chunk(name, arr)
62    }
63}
64
65impl<'a> ChunkFull<&'a [u8]> for BinaryChunked {
66    fn full(name: PlSmallStr, value: &'a [u8], length: usize) -> Self {
67        let mut builder = BinaryChunkedBuilder::new(name, length);
68        builder.chunk_builder.extend_constant(length, Some(value));
69        let mut out = builder.finish();
70        out.set_sorted_flag(IsSorted::Ascending);
71        out
72    }
73}
74
75impl ChunkFullNull for BinaryChunked {
76    fn full_null(name: PlSmallStr, length: usize) -> Self {
77        let arr =
78            BinaryViewArray::new_null(DataType::Binary.to_arrow(CompatLevel::newest()), length);
79        ChunkedArray::with_chunk(name, arr)
80    }
81}
82
83impl<'a> ChunkFull<&'a [u8]> for BinaryOffsetChunked {
84    fn full(name: PlSmallStr, value: &'a [u8], length: usize) -> Self {
85        let mut mutable = MutableBinaryArray::with_capacities(length, length * value.len());
86        mutable.extend_values(std::iter::repeat_n(value, length));
87        let arr: BinaryArray<i64> = mutable.into();
88        let mut out = ChunkedArray::with_chunk(name, arr);
89        out.set_sorted_flag(IsSorted::Ascending);
90        out
91    }
92}
93
94impl ChunkFullNull for BinaryOffsetChunked {
95    fn full_null(name: PlSmallStr, length: usize) -> Self {
96        let arr = BinaryArray::<i64>::new_null(
97            DataType::BinaryOffset.to_arrow(CompatLevel::newest()),
98            length,
99        );
100        ChunkedArray::with_chunk(name, arr)
101    }
102}
103
104impl ChunkFull<&Series> for ListChunked {
105    fn full(name: PlSmallStr, value: &Series, length: usize) -> ListChunked {
106        let mut builder = get_list_builder(value.dtype(), value.len() * length, length, name);
107        for _ in 0..length {
108            builder.append_series(value).unwrap();
109        }
110        builder.finish()
111    }
112}
113
114impl ChunkFullNull for ListChunked {
115    fn full_null(name: PlSmallStr, length: usize) -> ListChunked {
116        ListChunked::full_null_with_dtype(name, length, &DataType::Null)
117    }
118}
119
120#[cfg(feature = "dtype-array")]
121impl ArrayChunked {
122    pub fn full_null_with_dtype(
123        name: PlSmallStr,
124        length: usize,
125        inner_dtype: &DataType,
126        width: usize,
127    ) -> ArrayChunked {
128        let arr = FixedSizeListArray::new_null(
129            ArrowDataType::FixedSizeList(
130                Box::new(ArrowField::new(
131                    PlSmallStr::from_static("item"),
132                    inner_dtype.to_physical().to_arrow(CompatLevel::newest()),
133                    true,
134                )),
135                width,
136            ),
137            length,
138        );
139        // SAFETY: physical type matches the logical.
140        unsafe {
141            ChunkedArray::from_chunks_and_dtype(
142                name,
143                vec![Box::new(arr)],
144                DataType::Array(Box::new(inner_dtype.clone()), width),
145            )
146        }
147    }
148}
149
150#[cfg(feature = "dtype-array")]
151impl ChunkFull<&Series> for ArrayChunked {
152    fn full(name: PlSmallStr, value: &Series, length: usize) -> ArrayChunked {
153        let width = value.len();
154        let dtype = value.dtype();
155        let arrow_dtype = ArrowDataType::FixedSizeList(
156            Box::new(ArrowField::new(
157                PlSmallStr::from_static("item"),
158                dtype.to_physical().to_arrow(CompatLevel::newest()),
159                true,
160            )),
161            width,
162        );
163        let value = value.rechunk().chunks()[0].clone();
164        let arr = FixedSizeListArray::full(length, value, arrow_dtype);
165
166        // SAFETY: physical type matches the logical.
167        unsafe {
168            ChunkedArray::from_chunks_and_dtype(
169                name,
170                vec![Box::new(arr)],
171                DataType::Array(Box::new(dtype.clone()), width),
172            )
173        }
174    }
175}
176
177#[cfg(feature = "dtype-array")]
178impl ChunkFullNull for ArrayChunked {
179    fn full_null(name: PlSmallStr, length: usize) -> ArrayChunked {
180        ArrayChunked::full_null_with_dtype(name, length, &DataType::Null, 0)
181    }
182}
183
184impl ListChunked {
185    pub fn full_null_with_dtype(
186        name: PlSmallStr,
187        length: usize,
188        inner_dtype: &DataType,
189    ) -> ListChunked {
190        let arr: ListArray<i64> = ListArray::new_null(
191            ArrowDataType::LargeList(Box::new(ArrowField::new(
192                PlSmallStr::from_static("item"),
193                inner_dtype.to_physical().to_arrow(CompatLevel::newest()),
194                true,
195            ))),
196            length,
197        );
198        // SAFETY: physical type matches the logical.
199        unsafe {
200            ChunkedArray::from_chunks_and_dtype(
201                name,
202                vec![Box::new(arr)],
203                DataType::List(Box::new(inner_dtype.clone())),
204            )
205        }
206    }
207}
208#[cfg(feature = "dtype-struct")]
209impl ChunkFullNull for StructChunked {
210    fn full_null(name: PlSmallStr, length: usize) -> StructChunked {
211        StructChunked::from_series(name, length, [].iter())
212            .unwrap()
213            .with_outer_validity(Some(Bitmap::new_zeroed(length)))
214    }
215}
216
217#[cfg(feature = "object")]
218impl<T: PolarsObject> ChunkFull<T> for ObjectChunked<T> {
219    fn full(name: PlSmallStr, value: T, length: usize) -> Self
220    where
221        Self: Sized,
222    {
223        let mut ca: Self = (0..length).map(|_| Some(value.clone())).collect();
224        ca.rename(name);
225        ca
226    }
227}
228
229#[cfg(feature = "object")]
230impl<T: PolarsObject> ChunkFullNull for ObjectChunked<T> {
231    fn full_null(name: PlSmallStr, length: usize) -> ObjectChunked<T> {
232        let mut ca: Self = (0..length).map(|_| None).collect();
233        ca.rename(name);
234        ca
235    }
236}