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        if value.len() == 1 && !value.dtype().is_nested() {
107            let out = value
108                .new_from_index(0, length)
109                .reshape_list(&[
110                    ReshapeDimension::Infer,
111                    ReshapeDimension::Specified(Dimension::new(1)),
112                ])
113                .unwrap();
114            return out.list().unwrap().clone();
115        }
116
117        let mut builder = get_list_builder(value.dtype(), value.len() * length, length, name);
118        for _ in 0..length {
119            builder.append_series(value).unwrap();
120        }
121        builder.finish()
122    }
123}
124
125impl ChunkFullNull for ListChunked {
126    fn full_null(name: PlSmallStr, length: usize) -> ListChunked {
127        ListChunked::full_null_with_dtype(name, length, &DataType::Null)
128    }
129}
130
131#[cfg(feature = "dtype-array")]
132impl ArrayChunked {
133    pub fn full_null_with_dtype(
134        name: PlSmallStr,
135        length: usize,
136        inner_dtype: &DataType,
137        width: usize,
138    ) -> ArrayChunked {
139        let arr = FixedSizeListArray::new_null(
140            ArrowDataType::FixedSizeList(
141                Box::new(ArrowField::new(
142                    LIST_VALUES_NAME,
143                    inner_dtype.to_physical().to_arrow(CompatLevel::newest()),
144                    true,
145                )),
146                width,
147            ),
148            length,
149        );
150        // SAFETY: physical type matches the logical.
151        unsafe {
152            ChunkedArray::from_chunks_and_dtype(
153                name,
154                vec![Box::new(arr)],
155                DataType::Array(Box::new(inner_dtype.clone()), width),
156            )
157        }
158    }
159}
160
161#[cfg(feature = "dtype-array")]
162impl ChunkFull<&Series> for ArrayChunked {
163    fn full(name: PlSmallStr, value: &Series, length: usize) -> ArrayChunked {
164        let width = value.len();
165        let dtype = value.dtype();
166        let arrow_dtype = ArrowDataType::FixedSizeList(
167            Box::new(ArrowField::new(
168                LIST_VALUES_NAME,
169                dtype.to_physical().to_arrow(CompatLevel::newest()),
170                true,
171            )),
172            width,
173        );
174        let value = value.rechunk().chunks()[0].clone();
175        let arr = FixedSizeListArray::full(length, value, arrow_dtype);
176
177        // SAFETY: physical type matches the logical.
178        unsafe {
179            ChunkedArray::from_chunks_and_dtype(
180                name,
181                vec![Box::new(arr)],
182                DataType::Array(Box::new(dtype.clone()), width),
183            )
184        }
185    }
186}
187
188#[cfg(feature = "dtype-array")]
189impl ChunkFullNull for ArrayChunked {
190    fn full_null(name: PlSmallStr, length: usize) -> ArrayChunked {
191        ArrayChunked::full_null_with_dtype(name, length, &DataType::Null, 0)
192    }
193}
194
195impl ListChunked {
196    pub fn full_null_with_dtype(
197        name: PlSmallStr,
198        length: usize,
199        inner_dtype: &DataType,
200    ) -> ListChunked {
201        let arr: ListArray<i64> = ListArray::new_null(
202            ArrowDataType::LargeList(Box::new(ArrowField::new(
203                LIST_VALUES_NAME,
204                inner_dtype.to_physical().to_arrow(CompatLevel::newest()),
205                true,
206            ))),
207            length,
208        );
209        // SAFETY: physical type matches the logical.
210        unsafe {
211            ChunkedArray::from_chunks_and_dtype(
212                name,
213                vec![Box::new(arr)],
214                DataType::List(Box::new(inner_dtype.clone())),
215            )
216        }
217    }
218}
219#[cfg(feature = "dtype-struct")]
220impl ChunkFullNull for StructChunked {
221    fn full_null(name: PlSmallStr, length: usize) -> StructChunked {
222        StructChunked::from_series(name, length, [].iter())
223            .unwrap()
224            .with_outer_validity(Some(Bitmap::new_zeroed(length)))
225    }
226}
227
228#[cfg(feature = "object")]
229impl<T: PolarsObject> ChunkFull<T> for ObjectChunked<T> {
230    fn full(name: PlSmallStr, value: T, length: usize) -> Self
231    where
232        Self: Sized,
233    {
234        use crate::chunked_array::object::registry::run_with_gil;
235
236        run_with_gil(|| {
237            let mut ca: Self = (0..length).map(|_| Some(value.clone())).collect();
238            ca.rename(name);
239            ca
240        })
241    }
242}
243
244#[cfg(feature = "object")]
245impl<T: PolarsObject> ChunkFullNull for ObjectChunked<T> {
246    fn full_null(name: PlSmallStr, length: usize) -> ObjectChunked<T> {
247        use crate::chunked_array::object::registry::run_with_gil;
248
249        run_with_gil(|| {
250            let mut ca: Self = (0..length).map(|_| None).collect();
251            ca.rename(name);
252            ca
253        })
254    }
255}
polars_core/chunked_array/ops/full.rs

polars_core/chunked_array/ops/
full.rs
