annotate carfac/carfac_util.h @ 662:7e18c84ca2b7

Small cleanup of eigen usage in SAI implementation.

//
//  carfac_util.h
//  CARFAC Open Source C++ Library
//
//  Created by Alex Brandmeyer on 5/10/13.
//
// This C++ file is part of an implementation of Lyon's cochlear model:
// "Cascade of Asymmetric Resonators with Fast-Acting Compression"
// to supplement Lyon's upcoming book "Human and Machine Hearing"
//
// 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.

#ifndef CARFAC_CARFAC_UTIL_H
#define CARFAC_CARFAC_UTIL_H

#include "common.h"

// Returns the IHC detection nonilnearity function of the filter output values.
// This is here because it is called both in design and run phases.
ArrayX CARFACDetect(const ArrayX& x);

#endif  // CARFAC_CARFAC_UTIL_H