Coverage for src/cvxsimulator/utils/__init__.py: 100%

1# Copyright 2023 Stanford University Convex Optimization Group 

2# 

3# Licensed under the Apache License, Version 2.0 (the "License"); 

4# you may not use this file except in compliance with the License. 

5# You may obtain a copy of the License at 

6# 

7# http://www.apache.org/licenses/LICENSE-2.0 

8# 

9# Unless required by applicable law or agreed to in writing, software 

10# distributed under the License is distributed on an "AS IS" BASIS, 

11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 

12# See the License for the specific language governing permissions and 

13# limitations under the License. 

14"""Utility functions for the CVX Simulator package. 

15 

16This module provides various utility functions used throughout the simulator: 

17- grid: Functions for resampling time series data to a coarser grid 

18- interpolation: Functions for interpolating missing values in time series 

19- rescale: Functions for converting between returns and prices 

20""" 

21 

22from .interpolation import interpolate, interpolate_df_pl, interpolate_pl, valid, valid_df_pl, valid_pl 

23 

24__all__ = ["interpolate", "valid", "interpolate_pl", "valid_pl", "interpolate_df_pl", "valid_df_pl"]