// This file is a part of the mori - Material Orientation Library in Rust
// Copyright 2018 Robert Carson
//
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.

//! # mori - Material Orientation Library in Rust
//! An orientation library built around commonly used orientation representations used in crystallography and engineering applications. It contains conversion, rotation, and data analysis operations for various orientation spaces.
//!
//! Orientations play a large role in a number of fields ranging from: crystallography, x-ray diffraction, metallurgy, solid mechanics, and the list can go on and on. Therefore, it's important to have a library that easily allows conversions from Eulearian representations to rotation matrices to neo-eulerian representation to quaternions. 
//!
//! The initial scope of this library will provide common sets of conversions. In an attempt to have a consistent set of conversions with others in the field, a majority of these conversions have been taken from <sup name="a1">[1](#f1)</sup>. The library also includes various vector and tensor passive rotation operations. Operations such as these are commonly associatted with orientations. Therefore, a number of orientations support these features. Outside of these features, various helper methods have been added to several orientations representations such as being able to easily obtain the transpose of an orientation. It should be noted that these helper functions are not necessarily the same across different orientation conversions. 
//!
//! The code offers the following abilities:
//! * A set of conversions between commonly used orientation representations
//! * Vector and tensor rotation operations for a select few orientations.
//! * Parallel capabilities when the parallel feature flag is used.
//! * Convenient operations for select orientation conventions
//!
//! Later as it develops, the plan is to include the following:
//!
//! * Crystallographic fundamental region conversions
//! * Mean orientation calculations
//! * Misorientation calculations based upon the work of <sup name="a2">[2](#f2)</sup> <sup name="a3">[3](#f3)</sup>
//!
//!
//! <b id="f1">[1]:</b>[↩](#a1) D Rowenhorst et al 2015 Consistent representations of and conversions between 3D rotations Modelling Simul. Mater. Sci. Eng. 23 083501
//!
//! <b id="f2">[2]:</b>[↩](#a2) Barton N R and Dawson P R 2001 A methodology for determining average lattice orientation and its application to the characterization of grain substructure Metall. Mater. Trans. A 32 1967–75
//!
//! <b id="f3">[3]:</b>[↩](#a3) Glez J C and Driver J 2001 Orientation distribution analysis in deformed grains J. Appl. Cryst. 34 280–8
extern crate ndarray;

use ndarray::prelude::*;
#[cfg(feature = "parallel")]
use ndarray::parallel::par_azip;

///Contains orientation conversions from one to another, rotations of vectors and tensor data, and finally relative orientation operations
pub mod orientations;